X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeSelectionList.h;h=c5fe4c9349c007dd198181777c11c846187825ee;hb=f9d0d44c905c059bec472760bc436e06149c92ac;hp=37647df68f790e22247b873a49d8dbd6f6b43872;hpb=9e869ede4d8c56262bb20534543c2bf56cd6a91b;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h index 37647df68..c5fe4c934 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h +++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_AttributeSelectionList.h // Created: 22 Oct 2014 // Author: Mikhail PONIKAROV @@ -18,15 +20,47 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute { public: /// Adds the new reference to the end of the list - virtual void append( - const ResultPtr& theContext, const std::shared_ptr& theSubShape) = 0; + /// \param theContext object where the sub-shape was selected + /// \param theSubShape selected sub-shape (if null, the whole context is selected) + /// \param theTemporarily if it is true, do not store and name the added in the data framework + /// (used to remove immediately, without the following updates) + virtual void append(const ResultPtr& theContext, + const GeomShapePtr& theSubShape, + const bool theTemporarily = false) = 0; + + /// Adds the new reference to the end of the list by the naming name of the selected shape + /// The type of shape is taken from the current selection type if the given is empty + virtual void append(const std::string theNamingName, const std::string& theType = "") = 0; + + /// Reset temporary stored values + virtual void removeTemporaryValues() = 0; + + /// Removes the last element in the list + virtual void removeLast() = 0; - /// Returns the number ofselection attributes in the list + /// Removes the elements from the list. + /// \param theIndices a list of indices of elements to be removed + virtual void remove(const std::set& theIndices) = 0; + + /// Returns the number of selection attributes in the list virtual int size() = 0; - virtual int selectionType() = 0; + /// Returns true if the object with the shape are in list + /// \param theContext object where the sub-shape was selected + /// \param theSubShape selected sub-shape (if null, the whole context is selected) + /// \param theTemporarily if it is true, it checks also the temporary added item + /// \returns true if the pair is found in the attirbute + virtual bool isInList( + const ResultPtr& theContext, const std::shared_ptr& theSubShape, + const bool theTemporarily = false) = 0; + + /// The type of all elements selection + /// \returns the index of the enumeration of the type of shape + virtual const std::string selectionType() const = 0; - virtual void setSelectionType(int) = 0; + /// Sets the type of all elements selection + /// \param theType the index of the enumeration of the type of shape + virtual void setSelectionType(const std::string& theType) = 0; /// Returns the attribute selection by the index (zero based) virtual std::shared_ptr value(const int theIndex) = 0; @@ -34,28 +68,26 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute /// Returns all attributes virtual void clear() = 0; + /// Starts or stops cashing of the values in the attribute (the cash may become invalid + /// on modification of the attribute or sub-elements, so the cash must be enabled only + /// during non-modification operations with this attribute) + virtual void cashValues(const bool theEnabled) = 0; + /// Returns the type of this class of attributes - static std::string type() + static std::string typeId() { return "SelectionList"; } /// Returns the type of this class of attributes, not static method - virtual std::string attributeType() - { - return type(); - } + MODELAPI_EXPORT virtual std::string attributeType(); /// To virtually destroy the fields of successors - virtual ~ModelAPI_AttributeSelectionList() - { - } + MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList(); protected: /// Objects are created for features automatically - MODELAPI_EXPORT ModelAPI_AttributeSelectionList() - { - } + MODELAPI_EXPORT ModelAPI_AttributeSelectionList(); }; //! Pointer on double attribute