]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Recover.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Recover.h
1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
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 FEATURESPLUGIN_RECOVER_H_
21 #define FEATURESPLUGIN_RECOVER_H_
22
23 #include "FeaturesPlugin.h"
24 #include <ModelAPI_Feature.h>
25 #include <GeomAPI_Shape.h>
26
27 /**\class FeaturesPlugin_Recover
28  * \ingroup Plugins
29  * \brief Feature for display of concealed attributes of some feature.
30  */
31 class FeaturesPlugin_Recover : public ModelAPI_Feature
32 {
33   /// List of already registered unconcealed pairs of unconcealed result and feature that caused
34   /// concealment. If attributes of this feature were changed, this list helps to synchronise
35   /// the current state with validators.
36   std::set<std::shared_ptr<ModelAPI_Object> > myRegistered;
37   /// The last stored Base to unregister Unconcealed when even attributes are already erased.
38   FeaturePtr myCurrentBase;
39   /// previous state of persistent flag
40   bool myPersistent;
41   /// necessity to clean recovered list while changing the type of recover
42   bool myClearListOnTypeChange;
43  public:
44   /// Extrusion kind
45   inline static const std::string& ID()
46   {
47     static const std::string MY_RECOVER_ID("Recover");
48     return MY_RECOVER_ID;
49   }
50   /// Attribute name of base feature.
51   inline static const std::string& BASE_FEATURE()
52   {
53     static const std::string MY_BASE_FEATURE("base_feature");
54     return MY_BASE_FEATURE;
55   }
56
57   /// Attribute name of recovered results list.
58   inline static const std::string& RECOVERED_ENTITIES()
59   {
60     static const std::string MY_RECOVERED_ENTITIES_ID("recovered");
61     return MY_RECOVERED_ENTITIES_ID;
62   }
63
64   /// Attribute name of the type of recover.
65   inline static const std::string& METHOD()
66   {
67     static const std::string MY_METHOD_ID("method");
68     return MY_METHOD_ID;
69   }
70
71   /// Value of default method, recovering concealed objects only.
72   inline static const std::string& METHOD_DEFAULT()
73   {
74     static const std::string MY_METHOD_ID("default");
75     return MY_METHOD_ID;
76   }
77   /// Value of method, recovering parent compounds of concealed objects.
78   inline static const std::string& METHOD_COMPOUND()
79   {
80     static const std::string MY_METHOD_ID("compound");
81     return MY_METHOD_ID;
82   }
83
84   /// Returns the kind of a feature
85   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
86   {
87     static std::string MY_KIND = FeaturesPlugin_Recover::ID();
88     return MY_KIND;
89   }
90
91   /// Performs the algorithm and stores results it in the data structure.
92   FEATURESPLUGIN_EXPORT virtual void execute();
93
94   /// Request for initialization of data model of the feature: adding all attributes
95   FEATURESPLUGIN_EXPORT virtual void initAttributes();
96
97   /// Called on change of any argument-attribute of this object
98   /// \param theID identifier of changed attribute
99   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
100
101   /// Use plugin manager for features creation
102   FeaturesPlugin_Recover();
103
104 };
105
106 #endif