src/FeaturesAPI/FeaturesAPI_Copy.h

   1 // Copyright (C) 2014-2023  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 FeaturesAPI_Copy_H_
  21 #define FeaturesAPI_Copy_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_Copy.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Dumper;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_Copy
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Copy feature.
  36 class FeaturesAPI_Copy: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_Copy(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_Copy(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
  47                             const int theNumber);
  48
  49   /// Destructor.
  50   FEATURESAPI_EXPORT virtual ~FeaturesAPI_Copy();
  51
  52   INTERFACE_2(FeaturesPlugin_Copy::ID(),
  53               objects, FeaturesPlugin_Copy::OBJECTS(),
  54               ModelAPI_AttributeSelectionList, /** Source objects */,
  55               number, FeaturesPlugin_Copy::NUMBER(),
  56               ModelAPI_AttributeInteger, /** Number of copies */)
  57
  58   /// Modify objects attribute of the feature.
  59   FEATURESAPI_EXPORT void setObjects(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  60
  61   /// Modify number of copies attribute of the feature.
  62   FEATURESAPI_EXPORT void setNumber(const int theNumber);
  63
  64   /// Dump wrapped feature
  65   FEATURESAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  66 };
  67
  68 /// Pointer on Copy object.
  69 typedef std::shared_ptr<FeaturesAPI_Copy> CopyPtr;
  70
  71 /// \ingroup CPPHighAPI
  72 /// \brief Create Copy feature.
  73 FEATURESAPI_EXPORT
  74 CopyPtr addCopy(const std::shared_ptr<ModelAPI_Document>& thePart,
  75                 const std::list<ModelHighAPI_Selection>& theObjects,
  76                 const int theNumber);
  77
  78 #endif // FeaturesAPI_Copy_H_