src/FeaturesPlugin/FeaturesPlugin_Recover.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef FEATURESPLUGIN_RECOVER_H_
  22 #define FEATURESPLUGIN_RECOVER_H_
  23
  24 #include "FeaturesPlugin.h"
  25 #include <ModelAPI_Feature.h>
  26 #include <GeomAPI_Shape.h>
  27
  28 /**\class FeaturesPlugin_Recover
  29  * \ingroup Plugins
  30  * \brief Feature for display of concealed attributes of some feature.
  31  */
  32 class FeaturesPlugin_Recover : public ModelAPI_Feature
  33 {
  34   /// List of already registered unconcealed pairs of unconcealed result and feature that caused
  35   /// concealment. If attributes of this feature were changed, this list helps to synchronise
  36   /// the current state with validators.
  37   std::set<std::shared_ptr<ModelAPI_Object> > myRegistered;
  38   /// The last stored Base to unregister Unconcealed when even attributes are already erased.
  39   FeaturePtr myCurrentBase;
  40   /// previous state of persistent flag
  41   bool myPersistent;
  42  public:
  43   /// Extrusion kind
  44   inline static const std::string& ID()
  45   {
  46     static const std::string MY_RECOVER_ID("Recover");
  47     return MY_RECOVER_ID;
  48   }
  49   /// Attribute name of base feature.
  50   inline static const std::string& BASE_FEATURE()
  51   {
  52     static const std::string MY_BASE_FEATURE("base_feature");
  53     return MY_BASE_FEATURE;
  54   }
  55
  56   /// Attribute name of recovered results list.
  57   inline static const std::string& RECOVERED_ENTITIES()
  58   {
  59     static const std::string MY_RECOVERED_ENTITIES_ID("recovered");
  60     return MY_RECOVERED_ENTITIES_ID;
  61   }
  62
  63   /// Returns the kind of a feature
  64   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  65   {
  66     static std::string MY_KIND = FeaturesPlugin_Recover::ID();
  67     return MY_KIND;
  68   }
  69
  70   /// Creates a new part document if needed
  71   FEATURESPLUGIN_EXPORT virtual void execute();
  72
  73   /// Request for initialization of data model of the feature: adding all attributes
  74   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  75
  76   /// Use plugin manager for features creation
  77   FeaturesPlugin_Recover();
  78
  79 };
  80
  81 #endif