src/FeaturesAPI/FeaturesAPI_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 FeaturesAPI_Recover_H_
  22 #define FeaturesAPI_Recover_H_
  23
  24 #include "FeaturesAPI.h"
  25
  26 #include <FeaturesPlugin_Recover.h>
  27
  28 #include <ModelHighAPI_Interface.h>
  29 #include <ModelHighAPI_Macro.h>
  30
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Reference;
  33
  34 /// \class FeaturesAPI_Recover
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Recover feature.
  37 class FeaturesAPI_Recover: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Recover(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   FeaturesAPI_Recover(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                       const ModelHighAPI_Reference& theBaseFeature,
  48                       const std::list<ModelHighAPI_Selection>& theRecoveredList,
  49                       const bool thePersistent = false);
  50
  51   /// Destructor.
  52   FEATURESAPI_EXPORT
  53   virtual ~FeaturesAPI_Recover();
  54
  55   INTERFACE_2(FeaturesPlugin_Recover::ID(),
  56               baseFeature, FeaturesPlugin_Recover::BASE_FEATURE(),
  57               ModelAPI_AttributeReference, /** Concealed feature */,
  58               recoveredList, FeaturesPlugin_Recover::RECOVERED_ENTITIES(),
  59               ModelAPI_AttributeRefList, /** Recover list*/)
  60
  61   /// Set base feature.
  62   FEATURESAPI_EXPORT
  63   void setBaseFeature(const ModelHighAPI_Reference& theBaseFeature);
  64
  65   /// Set recovered list of the base feature
  66   FEATURESAPI_EXPORT
  67   void setRecoveredList(const std::list<ModelHighAPI_Selection>& theRecoverList);
  68
  69   /// Dump wrapped feature
  70   FEATURESAPI_EXPORT
  71   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  72 };
  73
  74 /// Pointer on Recover object.
  75 typedef std::shared_ptr<FeaturesAPI_Recover> RecoverPtr;
  76
  77 /// \ingroup CPPHighAPI
  78 /// \brief Create Recover feature.
  79 FEATURESAPI_EXPORT
  80 RecoverPtr addRecover(const std::shared_ptr<ModelAPI_Document>& thePart,
  81                       const ModelHighAPI_Reference& theBaseFeature,
  82                       const std::list<ModelHighAPI_Selection>& theRecoveredList,
  83                       const bool thePersistent = false);
  84
  85 #endif // FeaturesAPI_Recover_H_