src/CollectionAPI/CollectionAPI_Group.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef CollectionAPI_Group_H_
  22 #define CollectionAPI_Group_H_
  23
  24 #include "CollectionAPI.h"
  25
  26 #include <CollectionPlugin_Group.h>
  27
  28 #include <ModelHighAPI_Interface.h>
  29 #include <ModelHighAPI_Macro.h>
  30
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class CollectionAPI_Group
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Group feature.
  37 class CollectionAPI_Group: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   COLLECTIONAPI_EXPORT
  42   explicit CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   COLLECTIONAPI_EXPORT
  46   CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                     const std::list<ModelHighAPI_Selection>& theGroupList);
  48
  49   /// Destructor.
  50   COLLECTIONAPI_EXPORT
  51   virtual ~CollectionAPI_Group();
  52
  53   INTERFACE_1(CollectionPlugin_Group::ID(),
  54               groupList, CollectionPlugin_Group::LIST_ID(),
  55               ModelAPI_AttributeSelectionList, /** Group list*/)
  56
  57   /// Set main objects.
  58   COLLECTIONAPI_EXPORT
  59   void setGroupList(const std::list<ModelHighAPI_Selection>& theGroupList);
  60
  61   /// Dump wrapped feature
  62   COLLECTIONAPI_EXPORT
  63   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  64 };
  65
  66 /// Pointer on Group object.
  67 typedef std::shared_ptr<CollectionAPI_Group> GroupPtr;
  68
  69 /// \ingroup CPPHighAPI
  70 /// \brief Create Group feature.
  71 COLLECTIONAPI_EXPORT
  72 GroupPtr addGroup(const std::shared_ptr<ModelAPI_Document>& thePart,
  73                   const std::list<ModelHighAPI_Selection>& theGroupList,
  74                   const bool theShareSameTopology = false);
  75
  76 #endif // CollectionAPI_Group_H_