src/CollectionAPI/CollectionAPI_Group.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        CollectionAPI_Group.h
   4 // Created:     07 June 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef CollectionAPI_Group_H_
   8 #define CollectionAPI_Group_H_
   9
  10 #include "CollectionAPI.h"
  11
  12 #include <CollectionPlugin_Group.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Dumper;
  18 class ModelHighAPI_Selection;
  19
  20 /// \class CollectionAPI_Group
  21 /// \ingroup CPPHighAPI
  22 /// \brief Interface for Group feature.
  23 class CollectionAPI_Group: public ModelHighAPI_Interface
  24 {
  25 public:
  26   /// Constructor without values.
  27   COLLECTIONAPI_EXPORT
  28   explicit CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  29
  30   /// Constructor with values.
  31   COLLECTIONAPI_EXPORT
  32   CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  33                     const std::list<ModelHighAPI_Selection>& theGroupList);
  34
  35   /// Destructor.
  36   COLLECTIONAPI_EXPORT
  37   virtual ~CollectionAPI_Group();
  38
  39   INTERFACE_1(CollectionPlugin_Group::ID(),
  40               groupList, CollectionPlugin_Group::LIST_ID(),
  41               ModelAPI_AttributeSelectionList, /** Group list*/)
  42
  43   /// Set main objects.
  44   COLLECTIONAPI_EXPORT
  45   void setGroupList(const std::list<ModelHighAPI_Selection>& theGroupList);
  46
  47   /// Dump wrapped feature
  48   COLLECTIONAPI_EXPORT
  49   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  50 };
  51
  52 /// Pointer on Group object.
  53 typedef std::shared_ptr<CollectionAPI_Group> GroupPtr;
  54
  55 /// \ingroup CPPHighAPI
  56 /// \brief Create Group feature.
  57 COLLECTIONAPI_EXPORT
  58 GroupPtr addGroup(const std::shared_ptr<ModelAPI_Document>& thePart,
  59                   const std::list<ModelHighAPI_Selection>& theGroupList);
  60
  61 #endif // CollectionAPI_Group_H_