src/CollectionPlugin/CollectionPlugin_GroupSubstraction.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 COLLECTIONPLUGIN_GROUPSUBSTRACTION_H_
  21 #define COLLECTIONPLUGIN_GROUPSUBSTRACTION_H_
  22
  23 #include "CollectionPlugin.h"
  24 #include "CollectionPlugin_GroupOperation.h"
  25
  26 /**\class CollectionPlugin_GroupSubstraction
  27  * \ingroup Plugins
  28  * \brief Remove all elements in "objects" groups which contain in "tools" groups.
  29  */
  30 class CollectionPlugin_GroupSubstraction : public CollectionPlugin_GroupOperation
  31 {
  32 public:
  33   /// Extrusion kind
  34   inline static const std::string& ID()
  35   {
  36     static const std::string MY_GROUP_ID("GroupSubstraction");
  37     return MY_GROUP_ID;
  38   }
  39   /// attribute name of selected objects list
  40   inline static const std::string& LIST_ID()
  41   {
  42     static const std::string MY_GROUP_LIST_ID("group_list");
  43     return MY_GROUP_LIST_ID;
  44   }
  45   /// attribute name of selected tools list
  46   inline static const std::string& TOOLS_ID()
  47   {
  48     static const std::string MY_GROUP_LIST_ID("tools_list");
  49     return MY_GROUP_LIST_ID;
  50   }
  51
  52   /// Returns the kind of a feature
  53   COLLECTIONPLUGIN_EXPORT virtual const std::string& getKind()
  54   {
  55     static std::string MY_KIND = CollectionPlugin_GroupSubstraction::ID();
  56     return MY_KIND;
  57   }
  58
  59   /// Creates a new group result if needed
  60   COLLECTIONPLUGIN_EXPORT virtual void execute();
  61
  62   /// Request for initialization of data model of the feature: adding all attributes
  63   COLLECTIONPLUGIN_EXPORT virtual void initAttributes();
  64
  65   /// Use plugin manager for features creation
  66   CollectionPlugin_GroupSubstraction();
  67
  68 };
  69
  70 #endif