src/FeaturesAPI/FeaturesAPI_RemoveResults.h

   1 // Copyright (C) 2014-2023  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 FeaturesAPI_RemoveResults_H_
  21 #define FeaturesAPI_RemoveResults_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_RemoveResults.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Dumper;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_RemoveResults
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for RemoveResults feature.
  36 class FeaturesAPI_RemoveResults: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_RemoveResults(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42   /// Constructor with values.
  43   FEATURESAPI_EXPORT
  44   explicit FeaturesAPI_RemoveResults(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  45                                      const std::list<ModelHighAPI_Selection>& theResults);
  46
  47   /// Destructor.
  48   FEATURESAPI_EXPORT
  49   virtual ~FeaturesAPI_RemoveResults();
  50
  51   INTERFACE_1(FeaturesPlugin_RemoveResults::ID(),
  52               removed, FeaturesPlugin_RemoveResults::RESULTS_ID(),
  53               ModelAPI_AttributeSelectionList, /** Results to remove */)
  54
  55   /// Modify removed results arguments.
  56   FEATURESAPI_EXPORT
  57   void setRemoved(const std::list<ModelHighAPI_Selection>& theResults);
  58
  59   /// Dump wrapped feature
  60   FEATURESAPI_EXPORT
  61   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  62 };
  63
  64 /// Pointer on RemoveResults object.
  65 typedef std::shared_ptr<FeaturesAPI_RemoveResults> RemoveResultsPtr;
  66
  67 /// \ingroup CPPHighAPI
  68 /// \brief Create RemoveResults feature.
  69 FEATURESAPI_EXPORT
  70 RemoveResultsPtr addRemoveResults(const std::shared_ptr<ModelAPI_Document>& thePart,
  71                                   const std::list<ModelHighAPI_Selection>& theResults);
  72
  73 #endif // FeaturesAPI_RemoveResults_H_