Salome HOME
bos #26374 Merge branch 'CR26374'
[modules/shaper.git] / src / Model / Model_AttributeRefList.h
index c7d909b6b8bd0fb1e3e58f72a12458e17d4eaceb..340895fac6835c3f01efcf2015025126fa0e1f25 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        Model_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 Model_AttributeRefList_H_
 #define Model_AttributeRefList_H_
 #include "Model.h"
 #include "ModelAPI_AttributeRefList.h"
 #include "ModelAPI_Feature.h"
+#include "Model_Document.h"
 
 #include <TDataStd_ReferenceList.hxx>
+#include <TDataStd_ExtStringList.hxx>
 
 /**\class Model_AttributeRefList
  * \ingroup DataModel
- * \brief Attribute that contains list of references to features (located in the same document).
- * For the current moment it does not support references t oobjects in other documents.
+ * \brief Attribute that contains list of references to features, may be located in different documents.
  */
 
 class Model_AttributeRefList : public ModelAPI_AttributeRefList
 {
+  TDF_Label myLab; ///< the main label of this attribute
+
   Handle_TDataStd_ReferenceList myRef;  ///< references to the features labels
- public:
+  /// pairs of doc ID and entries if reference is to external object, appends some in this list if
+  /// something in myRef is empty
+  Handle_TDataStd_ExtStringList myExtDocRef;
+  bool myHashUsed; ///< true if the hash stored is valid
+  std::set<ObjectPtr> myHashObjects; ///< hashed information: objects existing in the list
+  std::map<int, ObjectPtr> myHashIndex; ///< index to object in the list
+  std::map<int, ObjectPtr> myHashIndexNoEmpty; ///< index to not empty object in the list
+public:
   /// Appends the feature to the end of a list
   MODEL_EXPORT virtual void append(ObjectPtr theObject);
 
@@ -45,16 +68,38 @@ class Model_AttributeRefList : public ModelAPI_AttributeRefList
   /// Returns the list of features
   ///\param theIndex zero-based index in the list
   ///\param theWithEmpty if it is false, counts the not-empty referenced objects only
-  MODEL_EXPORT virtual ObjectPtr object(const int theIndex, const bool theWithEmpty = true) const;
+  MODEL_EXPORT virtual ObjectPtr object(const int theIndex, const bool theWithEmpty = true);
 
   /// Substitutes the feature by another one. Does nothing if such object is not found.
+  /// Does not support the external documents objects yet.
   MODEL_EXPORT virtual void substitute(const ObjectPtr& theCurrent, const ObjectPtr& theNew);
 
+  /// Removes the last element in the list.
+  /// Does not support the external documents objects yet.
+  MODEL_EXPORT virtual void removeLast();
+
+  /// Removes the elements from the list.
+  /// Does not support the external documents objects yet.
+  /// \param theIndices a list of indices of elements to be removed
+  MODEL_EXPORT virtual void remove(const std::set<int>& theIndices);
+
   /// Returns true if attribute was  initialized by some value
   MODEL_EXPORT virtual bool isInitialized();
- protected:
+
+  /// Erases the hashed objects caused by complicated modifications in the list
+  void eraseHash();
+
+protected:
   /// Objects are created for features automatically
   MODEL_EXPORT Model_AttributeRefList(TDF_Label& theLabel);
+  /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
+  virtual void reinit();
+  /// Returns the object by iterators (theExtIter is iterated if necessary)
+  ObjectPtr iteratedObject(TDF_ListIteratorOfLabelList& theLIter,
+    TDataStd_ListIteratorOfListOfExtendedString& theExtIter,
+    std::shared_ptr<Model_Document> theDoc) const;
+  /// Creates the hash-objects containers (does nothing if hash is already correct)
+  void createHash();
 
   friend class Model_Data;
 };