1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef FeaturesAPI_Recover_H_
21 #define FeaturesAPI_Recover_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_Recover.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
30 class ModelHighAPI_Dumper;
31 class ModelHighAPI_Reference;
33 /// \class FeaturesAPI_Recover
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Recover feature.
36 class FeaturesAPI_Recover: public ModelHighAPI_Interface
39 /// Constructor without values.
41 explicit FeaturesAPI_Recover(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 /// Constructor with values.
45 FeaturesAPI_Recover(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const ModelHighAPI_Reference& theBaseFeature,
47 const std::list<ModelHighAPI_Selection>& theRecoveredList,
48 const bool theRecoverCompound = false);
52 virtual ~FeaturesAPI_Recover();
54 INTERFACE_2(FeaturesPlugin_Recover::ID(),
55 baseFeature, FeaturesPlugin_Recover::BASE_FEATURE(),
56 ModelAPI_AttributeReference, /** Concealed feature */,
57 recoveredList, FeaturesPlugin_Recover::RECOVERED_ENTITIES(),
58 ModelAPI_AttributeRefList, /** Recover list*/)
62 void setBaseFeature(const ModelHighAPI_Reference& theBaseFeature);
64 /// Set recovered list of the base feature
66 void setRecoveredList(const std::list<ModelHighAPI_Selection>& theRecoverList);
68 /// Dump wrapped feature
70 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
73 /// Pointer on Recover object.
74 typedef std::shared_ptr<FeaturesAPI_Recover> RecoverPtr;
76 /// \ingroup CPPHighAPI
77 /// \brief Create Recover feature.
79 RecoverPtr addRecover(const std::shared_ptr<ModelAPI_Document>& thePart,
80 const ModelHighAPI_Reference& theBaseFeature,
81 const std::list<ModelHighAPI_Selection>& theRecoveredList,
82 const bool theRecoverCompound = false);
84 #endif // FeaturesAPI_Recover_H_