SHAPER  9.12.0
FeaturesAPI_Recover.h
1 // Copyright (C) 2014-2023 CEA, EDF
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef FeaturesAPI_Recover_H_
21 #define FeaturesAPI_Recover_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_Recover.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 
32 
37 {
38 public:
40  FEATURESAPI_EXPORT
41  explicit FeaturesAPI_Recover(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42 
44  FEATURESAPI_EXPORT
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);
49 
51  FEATURESAPI_EXPORT
52  virtual ~FeaturesAPI_Recover();
53 
54  INTERFACE_2(FeaturesPlugin_Recover::ID(),
59 
60 
61  FEATURESAPI_EXPORT
62  void setBaseFeature(const ModelHighAPI_Reference& theBaseFeature);
63 
65  FEATURESAPI_EXPORT
66  void setRecoveredList(const std::list<ModelHighAPI_Selection>& theRecoverList);
67 
69  FEATURESAPI_EXPORT
70  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
71 };
72 
74 typedef std::shared_ptr<FeaturesAPI_Recover> RecoverPtr;
75 
78 FEATURESAPI_EXPORT
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);
83 
84 #endif // FeaturesAPI_Recover_H_
Interface for Recover feature.
Definition: FeaturesAPI_Recover.h:37
void setRecoveredList(const std::list< ModelHighAPI_Selection > &theRecoverList)
Set recovered list of the base feature.
Definition: FeaturesAPI_Recover.cpp:63
FeaturesAPI_Recover(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_Recover.cpp:27
void setBaseFeature(const ModelHighAPI_Reference &theBaseFeature)
Set base feature.
Definition: FeaturesAPI_Recover.cpp:55
virtual std::shared_ptr< ModelAPI_AttributeReference > baseFeature() const
Concealed feature.
Definition: FeaturesAPI_Recover.h:58
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_Recover.cpp:70
virtual std::shared_ptr< ModelAPI_AttributeRefList > recoveredList() const
Recover list.
Definition: FeaturesAPI_Recover.h:58
virtual ~FeaturesAPI_Recover()
Destructor.
Definition: FeaturesAPI_Recover.cpp:51
static const std::string & BASE_FEATURE()
Attribute name of base feature.
Definition: FeaturesPlugin_Recover.h:51
static const std::string & ID()
Extrusion kind.
Definition: FeaturesPlugin_Recover.h:45
static const std::string & RECOVERED_ENTITIES()
Attribute name of recovered results list.
Definition: FeaturesPlugin_Recover.h:58
Attribute that contains list of references to features (located in the same document).
Definition: ModelAPI_AttributeRefList.h:33
Attribute that contains reference to feature (located in the same document).
Definition: ModelAPI_AttributeReference.h:32
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeReference.
Definition: ModelHighAPI_Reference.h:41
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
RecoverPtr addRecover(const std::shared_ptr< ModelAPI_Document > &thePart, const ModelHighAPI_Reference &theBaseFeature, const std::list< ModelHighAPI_Selection > &theRecoveredList, const bool theRecoverCompound=false)
Create Recover feature.
Definition: FeaturesAPI_Recover.cpp:94