src/PartSetAPI/PartSetAPI_Part.h

   1 // Name   : PartSetAPI_Part.h
   2 // Purpose:
   3 //
   4 // History:
   5 // 16/06/16 - Sergey POKHODENKO - Creation of the file
   6
   7 #ifndef SRC_PARTSETAPI_PARTSETAPI_PART_H_
   8 #define SRC_PARTSETAPI_PARTSETAPI_PART_H_
   9
  10 //--------------------------------------------------------------------------------------
  11 #include "PartSetAPI.h"
  12
  13 #include <PartSetPlugin_Part.h>
  14
  15 #include <ModelHighAPI_Interface.h>
  16 #include <ModelHighAPI_Macro.h>
  17 //--------------------------------------------------------------------------------------
  18 class ModelAPI_Document;
  19 //--------------------------------------------------------------------------------------
  20 /**\class PartSetAPI_Part
  21  * \ingroup CPPHighAPI
  22  * \brief Interface for Part feature
  23  */
  24 class PartSetAPI_Part : public ModelHighAPI_Interface
  25 {
  26 public:
  27   /// Constructor without values
  28   PARTSETAPI_EXPORT
  29   explicit PartSetAPI_Part(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  30   /// Destructor
  31   PARTSETAPI_EXPORT
  32   virtual ~PartSetAPI_Part();
  33
  34   INTERFACE_0(PartSetPlugin_Part::ID())
  35
  36   /// Return document
  37   PARTSETAPI_EXPORT
  38   std::shared_ptr<ModelAPI_Document> document() const;
  39
  40   /// Dump wrapped feature
  41   PARTSETAPI_EXPORT
  42   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  43 };
  44
  45 //! Pointer on Part object
  46 typedef std::shared_ptr<PartSetAPI_Part> PartPtr;
  47
  48 /**\ingroup CPPHighAPI
  49  * \brief Create Part feature
  50  */
  51 PARTSETAPI_EXPORT
  52 PartPtr addPart(const std::shared_ptr<ModelAPI_Document> & thePartSet);
  53
  54 /**\ingroup CPPHighAPI
  55  * \brief Duplicate Part feature
  56  */
  57 PARTSETAPI_EXPORT
  58 PartPtr duplicatePart(const std::shared_ptr<ModelAPI_Document> & thePart);
  59
  60 /**\ingroup CPPHighAPI
  61  * \brief Remove Part feature
  62  */
  63 PARTSETAPI_EXPORT
  64 void removePart(const std::shared_ptr<ModelAPI_Document> & thePart);
  65
  66 //--------------------------------------------------------------------------------------
  67 //--------------------------------------------------------------------------------------
  68 #endif /* SRC_PARTSETAPI_PARTSETAPI_PART_H_ */