src/PartSetPlugin/PartSetPlugin_Part.h

   1 // File:        PartSetPlugin_Part.h
   2 // Created:     27 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef PartSetPlugin_Part_H_
   6 #define PartSetPlugin_Part_H_
   7
   8 #include "PartSetPlugin.h"
   9 #include <ModelAPI_Feature.h>
  10
  11 /**\class PartSetPlugin_Part
  12  * \ingroup DataModel
  13  * \brief Feature for creation of the new part in PartSet.
  14  */
  15 class PartSetPlugin_Part : public ModelAPI_Feature
  16 {
  17  public:
  18   /// Part kind
  19   inline static const std::string& ID()
  20   {
  21     static const std::string MY_PART_KIND("Part");
  22     return MY_PART_KIND;
  23   }
  24   /// Returns the kind of a feature
  25   PARTSETPLUGIN_EXPORT virtual const std::string& getKind()
  26   {
  27     static std::string MY_KIND = PartSetPlugin_Part::ID();
  28     return MY_KIND;
  29   }
  30
  31   /// Returns to which group in the document must be added feature
  32   PARTSETPLUGIN_EXPORT virtual const std::string& getGroup()
  33   {
  34     static std::string MY_GROUP = "Parts";
  35     return MY_GROUP;
  36   }
  37
  38   /// Creates a new part document if needed
  39   PARTSETPLUGIN_EXPORT virtual void execute();
  40
  41   /// Request for initialization of data model of the feature: adding all attributes
  42   PARTSETPLUGIN_EXPORT virtual void initAttributes();
  43
  44   PARTSETPLUGIN_EXPORT virtual boost::shared_ptr<ModelAPI_Document> documentToAdd();
  45
  46   /// Returns true if this feature must be displayed in the history (top level of Part tree)
  47   PARTSETPLUGIN_EXPORT virtual bool isInHistory()
  48   {
  49     return false;
  50   }
  51
  52   /// Use plugin manager for features creation
  53   PartSetPlugin_Part();
  54 };
  55
  56 #endif