X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeRefList.h;h=93f3e44d2e8e60fa103222baab76fca69f0c9719;hb=c02fae5493cc6d56c9a1db3bdcf6d872f88fea07;hp=b897c1b4250e173bb3591bdd0ac425b330f07ff5;hpb=3985b767e74385e51d1b503d2c97d3bb1e3f6faa;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeRefList.h b/src/ModelAPI/ModelAPI_AttributeRefList.h index b897c1b42..93f3e44d2 100644 --- a/src/ModelAPI/ModelAPI_AttributeRefList.h +++ b/src/ModelAPI/ModelAPI_AttributeRefList.h @@ -1,9 +1,24 @@ -// File: ModelAPI_AttributeRefList.h -// Created: 8 May 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// -#ifndef ModelAPI_AttributeRefList_HeaderFile -#define ModelAPI_AttributeRefList_HeaderFile +#ifndef ModelAPI_AttributeRefList_H_ +#define ModelAPI_AttributeRefList_H_ #include "ModelAPI_Attribute.h" #include "ModelAPI_Feature.h" @@ -16,29 +31,57 @@ 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) = 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: + /// 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