src/FeaturesPlugin/FeaturesPlugin_RemoveSubShapes.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_RemoveSubShapes_H_
  21 #define FeaturesPlugin_RemoveSubShapes_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 /// \class FeaturesPlugin_RemoveSubShapes
  28 /// \ingroup Plugins
  29 /// \brief Feature for removing sub-shapes from collections(wire, shell, compsolid, compound).
  30 class FeaturesPlugin_RemoveSubShapes: public ModelAPI_Feature
  31 {
  32 public:
  33   /// Use plugin manager for features creation
  34   FeaturesPlugin_RemoveSubShapes();
  35
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("Remove_SubShapes");
  40     return MY_ID;
  41   }
  42
  43   /// Attribute name of base shape.
  44   inline static const std::string& BASE_SHAPE_ID()
  45   {
  46     static const std::string MY_BASE_SHAPE_ID("base_shape");
  47     return MY_BASE_SHAPE_ID;
  48   }
  49
  50   /// Attribute name for creation method.
  51   inline static const std::string& CREATION_METHOD()
  52   {
  53     static const std::string MY_CREATION_METHOD_ID("creation_method");
  54     return MY_CREATION_METHOD_ID;
  55   }
  56
  57   /// Attribute name for creation method.
  58   inline static const std::string& CREATION_METHOD_BY_KEEP_SUBSHAPES()
  59   {
  60     static const std::string MY_CREATION_METHOD_ID("by_keep_subshapes");
  61     return MY_CREATION_METHOD_ID;
  62   }
  63
  64   /// Attribute name for creation method.
  65   inline static const std::string& CREATION_METHOD_BY_REMOVE_SUBSHAPES()
  66   {
  67     static const std::string MY_CREATION_METHOD_ID("by_remove_subshapes");
  68     return MY_CREATION_METHOD_ID;
  69   }
  70
  71   /// Attribute name of sub-shapes to keep.
  72   inline static const std::string& SUBSHAPES_TO_KEEP_ID()
  73   {
  74     static const std::string MY_SUBSHAPES_ID("subshapes_to_keep");
  75     return MY_SUBSHAPES_ID;
  76   }
  77
  78   /// Attribute name of sub-shapes to remove.
  79   inline static const std::string& SUBSHAPES_TO_REMOVE_ID()
  80   {
  81     static const std::string MY_SUBSHAPES_ID("subshapes_to_remove");
  82     return MY_SUBSHAPES_ID;
  83   }
  84
  85
  86   /// \return the kind of a feature.
  87   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  88   {
  89     static std::string MY_KIND = FeaturesPlugin_RemoveSubShapes::ID();
  90     return MY_KIND;
  91   }
  92
  93   /// Request for initialization of data model of the feature: adding all attributes.
  94   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  95
  96   /// Called on change of any argument-attribute of this object.
  97   /// \param[in] theID identifier of changed attribute.
  98   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  99
 100   /// Performs the algorithm and stores results it in the data structure.
 101   FEATURESPLUGIN_EXPORT virtual void execute();
 102
 103 private:
 104   bool myChangedInCode;
 105 };
 106
 107 #endif