1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_AttributeSelectionList.h
4 // Created: 22 Oct 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_AttributeSelectionList_H_
8 #define ModelAPI_AttributeSelectionList_H_
10 #include "ModelAPI_AttributeSelection.h"
11 #include <ModelAPI_Result.h>
13 /**\class ModelAPI_AttributeSelectionList
15 * \brief Attribute that contains list of references to the sub-shapes with
16 * possibility to manage them.
19 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
22 /// Adds the new reference to the end of the list
23 /// \param theContext object where the sub-shape was selected
24 /// \param theSubShape selected sub-shape (if null, the whole context is selected)
25 /// \param theTemporarily if it is true, do not store and name the added in the data framework
26 /// (used to remove immediately, without the following updates)
27 virtual void append(const ResultPtr& theContext,
28 const GeomShapePtr& theSubShape,
29 const bool theTemporarily = false) = 0;
31 /// Adds the new reference to the end of the list by the naming name of the selected shape
32 /// The type of shape is taken from the current selection type if the given is empty
33 virtual void append(const std::string theNamingName, const std::string& theType = "") = 0;
35 /// Removes the last element in the list
36 virtual void removeLast() = 0;
38 /// Removes the elements from the list.
39 /// \param theIndices a list of indices of elements to be removed
40 virtual void remove(const std::set<int>& theIndices) = 0;
42 /// Returns the number of selection attributes in the list
43 virtual int size() = 0;
45 /// Returns true if the object with the shape are in list
46 /// \param theContext object where the sub-shape was selected
47 /// \param theSubShape selected sub-shape (if null, the whole context is selected)
48 /// \param theTemporarily if it is true, it checks also the temporary added item
49 /// \returns true if the pair is found in the attirbute
50 virtual bool isInList(
51 const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
52 const bool theTemporarily = false) = 0;
54 /// The type of all elements selection
55 /// \returns the index of the enumeration of the type of shape
56 virtual const std::string selectionType() const = 0;
58 /// Sets the type of all elements selection
59 /// \param theType the index of the enumeration of the type of shape
60 virtual void setSelectionType(const std::string& theType) = 0;
62 /// Returns the attribute selection by the index (zero based)
63 virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
65 /// Returns all attributes
66 virtual void clear() = 0;
68 /// Starts or stops cashing of the values in the attribute (the cash may become invalid
69 /// on modification of the attribute or sub-elements, so the cash must be enabled only
70 /// during non-modification operations with this attribute)
71 virtual void cashValues(const bool theEnabled) = 0;
73 /// Returns the type of this class of attributes
74 static std::string typeId()
76 return "SelectionList";
79 /// Returns the type of this class of attributes, not static method
80 MODELAPI_EXPORT virtual std::string attributeType();
82 /// To virtually destroy the fields of successors
83 MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
86 /// Objects are created for features automatically
87 MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
90 //! Pointer on double attribute
91 typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;