src/Model/Model_AttributeRefList.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Model_AttributeRefList_H_
  21 #define Model_AttributeRefList_H_
  22
  23 #include "Model.h"
  24 #include "ModelAPI_AttributeRefList.h"
  25 #include "ModelAPI_Feature.h"
  26 #include "Model_Document.h"
  27
  28 #include <TDataStd_ReferenceList.hxx>
  29 #include <TDataStd_ExtStringList.hxx>
  30
  31 /**\class Model_AttributeRefList
  32  * \ingroup DataModel
  33  * \brief Attribute that contains list of references to features, may be located in different documents.
  34  */
  35
  36 class Model_AttributeRefList : public ModelAPI_AttributeRefList
  37 {
  38   TDF_Label myLab; ///< the main label of this attribute
  39
  40   Handle_TDataStd_ReferenceList myRef;  ///< references to the features labels
  41   /// pairs of doc ID and entries if reference is to external object, appends some in this list if
  42   /// something in myRef is empty
  43   Handle_TDataStd_ExtStringList myExtDocRef;
  44   bool myHashUsed; ///< true if the hash stored is valid
  45   std::set<ObjectPtr> myHashObjects; ///< hashed information: objects existing in the list
  46   std::map<int, ObjectPtr> myHashIndex; ///< index to object in the list
  47   std::map<int, ObjectPtr> myHashIndexNoEmpty; ///< index to not empty object in the list
  48 public:
  49   /// Appends the feature to the end of a list
  50   MODEL_EXPORT virtual void append(ObjectPtr theObject);
  51
  52   /// Erases the first meet of the feature in the list
  53   MODEL_EXPORT virtual void remove(ObjectPtr theObject);
  54
  55   /// Returns number of features in the list
  56   ///\param theWithEmpty if it is false, returns the number of not-empty referenced objects
  57   MODEL_EXPORT virtual int size(const bool theWithEmpty = true) const;
  58
  59   /// Removes all references from the list
  60   MODEL_EXPORT virtual void clear();
  61
  62   /// Returns the list of features
  63   MODEL_EXPORT virtual std::list<ObjectPtr> list();
  64
  65   /// Returns true if the object is in list
  66   MODEL_EXPORT virtual bool isInList(const ObjectPtr& theObj);
  67
  68   /// Returns the list of features
  69   ///\param theIndex zero-based index in the list
  70   ///\param theWithEmpty if it is false, counts the not-empty referenced objects only
  71   MODEL_EXPORT virtual ObjectPtr object(const int theIndex, const bool theWithEmpty = true);
  72
  73   /// Substitutes the feature by another one. Does nothing if such object is not found.
  74   /// Does not support the external documents objects yet.
  75   MODEL_EXPORT virtual void substitute(const ObjectPtr& theCurrent, const ObjectPtr& theNew);
  76
  77   /// Removes the last element in the list.
  78   /// Does not support the external documents objects yet.
  79   MODEL_EXPORT virtual void removeLast();
  80
  81   /// Removes the elements from the list.
  82   /// Does not support the external documents objects yet.
  83   /// \param theIndices a list of indices of elements to be removed
  84   MODEL_EXPORT virtual void remove(const std::set<int>& theIndices);
  85
  86   /// Returns true if attribute was  initialized by some value
  87   MODEL_EXPORT virtual bool isInitialized();
  88
  89   /// Erases the hashed objects caused by complicated modifications in the list
  90   void eraseHash();
  91
  92 protected:
  93   /// Objects are created for features automatically
  94   MODEL_EXPORT Model_AttributeRefList(TDF_Label& theLabel);
  95   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  96   virtual void reinit();
  97   /// Returns the object by iterators (theExtIter is iterated if necessary)
  98   ObjectPtr iteratedObject(TDF_ListIteratorOfLabelList& theLIter,
  99     TDataStd_ListIteratorOfListOfExtendedString& theExtIter,
 100     std::shared_ptr<Model_Document> theDoc) const;
 101   /// Creates the hash-objects containers (does nothing if hash is already correct)
 102   void createHash();
 103
 104   friend class Model_Data;
 105 };
 106
 107 #endif