src/PartSetPlugin/PartSetPlugin_Part.h

   1 // Copyright (C) 2014-2022  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 PartSetPlugin_Part_H_
  21 #define PartSetPlugin_Part_H_
  22
  23 #include "PartSetPlugin.h"
  24 #include <ModelAPI_CompositeFeature.h>
  25
  26 /**\class PartSetPlugin_Part
  27  * \ingroup Plugins
  28  * \brief Feature for creation of the new part in PartSet.
  29  * All sub-features are sub-elements of composite feature.
  30  */
  31 class PartSetPlugin_Part : public ModelAPI_CompositeFeature
  32 {
  33  public:
  34   /// Part kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_PART_KIND("Part");
  38     return MY_PART_KIND;
  39   }
  40   /// Returns the kind of a feature
  41   PARTSETPLUGIN_EXPORT virtual const std::string& getKind()
  42   {
  43     static std::string MY_KIND = PartSetPlugin_Part::ID();
  44     return MY_KIND;
  45   }
  46
  47 //LCOV_EXCL_START
  48   /// Returns to which group in the document must be added feature
  49   PARTSETPLUGIN_EXPORT virtual const std::string& getGroup()
  50   {
  51     static std::string MY_GROUP = "Parts";
  52     return MY_GROUP;
  53   }
  54 //LCOV_EXCL_STOP
  55
  56   /// Creates a new part document if needed
  57   PARTSETPLUGIN_EXPORT virtual void execute();
  58
  59   /// Request for initialization of data model of the feature: adding all attributes
  60   PARTSETPLUGIN_EXPORT virtual void initAttributes();
  61
  62   /// Part must be added only to PartSet
  63   PARTSETPLUGIN_EXPORT virtual const std::string& documentToAdd();
  64
  65   // composite feature methods
  66
  67   /// Adds feature to its document
  68   virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
  69
  70   /// Returns the number of sub-features of the document
  71   virtual int numberOfSubs(bool forTree = false) const;
  72
  73   /// Returns the sub-feature by zero-base index
  74   virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
  75
  76   /// Returns the sub-feature unique identifier in this composite feature by zero-base index
  77   virtual int subFeatureId(const int theIndex) const;
  78
  79   /// Returns true if feature or reuslt belong to this composite feature as subs
  80   virtual bool isSub(ObjectPtr theObject) const;
  81
  82   /// This method to inform that sub-feature is removed and must be removed from the internal data
  83   /// structures of the owner (the remove from the document will be done outside just after)
  84   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) {}
  85
  86   /// Use plugin manager for features creation
  87   PartSetPlugin_Part();
  88
  89   /// Just removes all features of the part without touching the document data (to be able undo)
  90   PARTSETPLUGIN_EXPORT virtual void erase();
  91 };
  92
  93 #endif