src/ModelAPI/ModelAPI_AttributeSelectionList.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_AttributeSelectionList.h
   4 // Created:     22 Oct 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_AttributeSelectionList_H_
   8 #define ModelAPI_AttributeSelectionList_H_
   9
  10 #include "ModelAPI_AttributeSelection.h"
  11 #include <ModelAPI_Result.h>
  12
  13 /**\class ModelAPI_AttributeSelectionList
  14  * \ingroup DataModel
  15  * \brief Attribute that contains list of references to the sub-shapes with
  16  * possibility to manage them.
  17  */
  18
  19 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
  20 {
  21  public:
  22   /// Adds the new reference to the end of the list
  23   virtual void append(const ResultPtr& theContext,
  24                       const GeomShapePtr& theSubShape) = 0;
  25
  26   /// Adds the new reference to the end of the list by the naming name of the selected shape
  27   /// The type of shape is taken from the current selection type
  28   virtual void append(std::string theNamingName) = 0;
  29
  30   /// Returns the number ofselection attributes in the list
  31   virtual int size() = 0;
  32
  33   /// The type of all elements selection
  34   /// \returns the index of the enumeration of the type of shape
  35   virtual const std::string selectionType() const = 0;
  36
  37   /// Sets the type of all elements selection
  38   /// \param theType the index of the enumeration of the type of shape
  39   virtual void setSelectionType(const std::string& theType) = 0;
  40
  41   /// Returns the attribute selection by the index (zero based)
  42   virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
  43
  44   /// Returns all attributes
  45   virtual void clear() = 0;
  46
  47   /// Returns the type of this class of attributes
  48   static std::string typeId()
  49   {
  50     return "SelectionList";
  51   }
  52
  53   /// Returns the type of this class of attributes, not static method
  54   MODELAPI_EXPORT virtual std::string attributeType();
  55
  56   /// To virtually destroy the fields of successors
  57   MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
  58
  59  protected:
  60   /// Objects are created for features automatically
  61   MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
  62 };
  63
  64 //! Pointer on double attribute
  65 typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
  66
  67 #endif