X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeRefList.h;h=101fc8695959e9a84470cead938bf45f1c6011f9;hb=0f22bfc2773dcbb793c2c9c6562d25e114250617;hp=d9948dd04d27a15e7d74032de20250fbbfbbe4b5;hpb=96ff1d1fb2acb842cee193f15492de81060a1d58;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeRefList.h b/src/ModelAPI/ModelAPI_AttributeRefList.h index d9948dd04..101fc8695 100644 --- a/src/ModelAPI/ModelAPI_AttributeRefList.h +++ b/src/ModelAPI/ModelAPI_AttributeRefList.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_AttributeRefList.h // Created: 8 May 2014 // Author: Mikhail PONIKAROV @@ -16,29 +18,60 @@ class ModelAPI_AttributeRefList : public ModelAPI_Attribute { -public: + public: /// Returns the type of this class of attributes - MODELAPI_EXPORT static std::string type() {return "RefList";} + MODELAPI_EXPORT static std::string typeId() + { + return "RefList"; + } /// Returns the type of this class of attributes, not static method - MODELAPI_EXPORT virtual std::string attributeType() {return type();} + MODELAPI_EXPORT virtual std::string attributeType(); /// Appends the feature to the end of a list - MODELAPI_EXPORT virtual void append(ObjectPtr theObject) = 0; + virtual void append(ObjectPtr theObject) = 0; /// Erases the first meet of the feature in the list - MODELAPI_EXPORT virtual void remove(ObjectPtr theObject) = 0; + virtual void remove(ObjectPtr theObject) = 0; + + /// Removes all references from the list + virtual void clear() = 0; /// Returns number of features in the list - MODELAPI_EXPORT virtual int size() = 0; + ///\param theWithEmpty if it is false, returns the number of not-empty referenced objects + virtual int size(const bool theWithEmpty = true) const = 0; /// Returns the list of features - MODELAPI_EXPORT virtual std::list list() = 0; + virtual std::list list() = 0; + + /// Returns true if the object is in list + virtual bool isInList(const ObjectPtr& theObj) = 0; + + /// Returns the referenced object by the zero-based index + ///\param theIndex zero-based index in the list + ///\param theWithEmpty if it is false, counts the not-empty referenced objects only + virtual ObjectPtr object(const int theIndex, const bool theWithEmpty = true) const = 0; + + /// Substitutes the object by another one. Does nothing if such object is not found. + virtual void substitute(const ObjectPtr& theCurrent, const ObjectPtr& theNew) = 0; -protected: + /// Substitutes the object by another one and back. So, features wil become exchanged in the list + virtual void exchange(const ObjectPtr& theObject1, const ObjectPtr& theObject2) = 0; + + /// Removes the last element in the list. + virtual void removeLast() = 0; + + /// 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; + + MODELAPI_EXPORT virtual ~ModelAPI_AttributeRefList(); + protected: /// Objects are created for features automatically - MODELAPI_EXPORT ModelAPI_AttributeRefList() - {} + MODELAPI_EXPORT ModelAPI_AttributeRefList(); + }; +typedef std::shared_ptr AttributeRefListPtr; + #endif