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