src/PartSetAPI/PartSetAPI_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 SRC_PARTSETAPI_PARTSETAPI_PART_H_
  22 #define SRC_PARTSETAPI_PARTSETAPI_PART_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include "PartSetAPI.h"
  26
  27 #include <PartSetPlugin_Part.h>
  28
  29 #include <ModelHighAPI_Interface.h>
  30 #include <ModelHighAPI_Macro.h>
  31 //--------------------------------------------------------------------------------------
  32 class ModelAPI_Document;
  33 //--------------------------------------------------------------------------------------
  34 /**\class PartSetAPI_Part
  35  * \ingroup CPPHighAPI
  36  * \brief Interface for Part feature
  37  */
  38 class PartSetAPI_Part : public ModelHighAPI_Interface
  39 {
  40 public:
  41   /// Constructor without values
  42   PARTSETAPI_EXPORT
  43   explicit PartSetAPI_Part(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  44   /// Destructor
  45   PARTSETAPI_EXPORT
  46   virtual ~PartSetAPI_Part();
  47
  48   INTERFACE_0(PartSetPlugin_Part::ID())
  49
  50   /// Return document
  51   PARTSETAPI_EXPORT
  52   std::shared_ptr<ModelAPI_Document> document() const;
  53
  54   /// Dump wrapped feature
  55   PARTSETAPI_EXPORT
  56   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  57 };
  58
  59 //! Pointer on Part object
  60 typedef std::shared_ptr<PartSetAPI_Part> PartPtr;
  61
  62 /**\ingroup CPPHighAPI
  63  * \brief Create Part feature
  64  */
  65 PARTSETAPI_EXPORT
  66 PartPtr addPart(const std::shared_ptr<ModelAPI_Document> & thePartSet);
  67
  68 /**\ingroup CPPHighAPI
  69  * \brief Duplicate Part feature
  70  */
  71 PARTSETAPI_EXPORT
  72 PartPtr duplicatePart(const ModelHighAPI_Interface& thePart);
  73
  74 /**\ingroup CPPHighAPI
  75  * \brief Remove Part feature
  76  */
  77 PARTSETAPI_EXPORT
  78 void removePart(const ModelHighAPI_Interface& thePart);
  79
  80 //--------------------------------------------------------------------------------------
  81 //--------------------------------------------------------------------------------------
  82 #endif /* SRC_PARTSETAPI_PARTSETAPI_PART_H_ */