src/PartSetAPI/PartSetAPI_Part.h

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