-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: ModelAPI_AttributeRefList.h
-// Created: 8 May 2014
-// Author: Mikhail PONIKAROV
+// Copyright (C) 2014-2021 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_H_
#define ModelAPI_AttributeRefList_H_
{
public:
/// Returns the type of this class of attributes
- MODELAPI_EXPORT static std::string type()
+ MODELAPI_EXPORT static std::string typeId()
{
return "RefList";
}
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() const = 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<ObjectPtr> list() = 0;
+ virtual std::list<ObjectPtr> 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;
+
+ /// Removes the last element in the list.
+ virtual void removeLast() = 0;
- /// Returns the referenced object by the zero-based index
- MODELAPI_EXPORT virtual ObjectPtr object(const int theIndex) const = 0;
+ /// Removes the elements from the list.
+ /// \param theIndices a list of indices of elements to be removed
+ virtual void remove(const std::set<int>& theIndices) = 0;
MODELAPI_EXPORT virtual ~ModelAPI_AttributeRefList();
protected:
