]> SALOME platform Git repositories - modules/shaper.git/blob - src/CollectionAPI/CollectionAPI_GroupAddition.h
Salome HOME
4ba42468704a4681a5637650391df58768151595
[modules/shaper.git] / src / CollectionAPI / CollectionAPI_GroupAddition.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 CollectionAPI_GroupAddition_H_
21 #define CollectionAPI_GroupAddition_H_
22
23 #include "CollectionAPI.h"
24
25 #include <CollectionPlugin_GroupAddition.h>
26
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29
30 class ModelHighAPI_Dumper;
31 class ModelHighAPI_Selection;
32
33 /// \class CollectionAPI_GroupAddition
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Group Addition feature.
36 class CollectionAPI_GroupAddition : public ModelHighAPI_Interface
37 {
38 public:
39   /// Constructor without values.
40   COLLECTIONAPI_EXPORT
41   explicit CollectionAPI_GroupAddition(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42
43   /// Constructor with values.
44   COLLECTIONAPI_EXPORT
45   CollectionAPI_GroupAddition(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46                               const std::list<ModelHighAPI_Selection>& theGroupList);
47
48   /// Destructor.
49   COLLECTIONAPI_EXPORT
50   virtual ~CollectionAPI_GroupAddition();
51
52   INTERFACE_1(CollectionPlugin_GroupAddition::ID(),
53               groupList, CollectionPlugin_GroupAddition::LIST_ID(),
54               ModelAPI_AttributeSelectionList, /** Group list*/)
55
56   /// Set main objects.
57   COLLECTIONAPI_EXPORT
58   void setGroupList(const std::list<ModelHighAPI_Selection>& theGroupList);
59
60   /// Dump wrapped feature
61   COLLECTIONAPI_EXPORT
62   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
63 };
64
65 /// Pointer on Group Addition object.
66 typedef std::shared_ptr<CollectionAPI_GroupAddition> GroupAdditionPtr;
67
68 /// \ingroup CPPHighAPI
69 /// \brief Create Group Addition feature.
70 COLLECTIONAPI_EXPORT
71 GroupAdditionPtr addGroupAddition(const std::shared_ptr<ModelAPI_Document>& thePart,
72                                   const std::list<ModelHighAPI_Selection>& theGroupsList);
73
74 #endif // CollectionAPI_GroupAddition_H_