Salome HOME
Copyright update 2020
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Recover.h
index 438ee950e88cb90eaa4dd6df0bb84c895cb7f49f..47edd6a33b9d76b0b44f2406f90d0c040a2c007a 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesPlugin_Recover.h
-// Created:     29 Jul 2016
-// Author:      Natalia ERMOLAEVA
+// Copyright (C) 2014-2020  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef FEATURESPLUGIN_RECOVER_H_
 #define FEATURESPLUGIN_RECOVER_H_
@@ -25,6 +38,8 @@ class FeaturesPlugin_Recover : public ModelAPI_Feature
   FeaturePtr myCurrentBase;
   /// previous state of persistent flag
   bool myPersistent;
+  /// necessity to clean recovered list while changing the type of recover
+  bool myClearListOnTypeChange;
  public:
   /// Extrusion kind
   inline static const std::string& ID()
@@ -46,6 +61,26 @@ class FeaturesPlugin_Recover : public ModelAPI_Feature
     return MY_RECOVERED_ENTITIES_ID;
   }
 
+  /// Attribute name of the type of recover.
+  inline static const std::string& METHOD()
+  {
+    static const std::string MY_METHOD_ID("method");
+    return MY_METHOD_ID;
+  }
+
+  /// Value of default method, recovering concealed objects only.
+  inline static const std::string& METHOD_DEFAULT()
+  {
+    static const std::string MY_METHOD_ID("default");
+    return MY_METHOD_ID;
+  }
+  /// Value of method, recovering parent compounds of concealed objects.
+  inline static const std::string& METHOD_COMPOUND()
+  {
+    static const std::string MY_METHOD_ID("compound");
+    return MY_METHOD_ID;
+  }
+
   /// Returns the kind of a feature
   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
   {
@@ -53,12 +88,16 @@ class FeaturesPlugin_Recover : public ModelAPI_Feature
     return MY_KIND;
   }
 
-  /// Creates a new part document if needed
+  /// Performs the algorithm and stores results it in the data structure.
   FEATURESPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
   FEATURESPLUGIN_EXPORT virtual void initAttributes();
 
+  /// Called on change of any argument-attribute of this object
+  /// \param theID identifier of changed attribute
+  FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
+
   /// Use plugin manager for features creation
   FeaturesPlugin_Recover();