src/FeaturesAPI/FeaturesAPI_Group.h

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