Salome HOME
Issue #1662: implementation of Recover feature.
[modules/shaper.git] / src / Model / Model_Data.h
index cf90469ba46acfc003a3bf602e8e9ad96767c4aa..6264e68b5ae1b054ff348b2f9cd87a418f41f76f 100644 (file)
@@ -16,6 +16,7 @@
 #include <ModelAPI_AttributeRefAttr.h>
 #include <ModelAPI_AttributeReference.h>
 #include <ModelAPI_AttributeRefList.h>
+#include <ModelAPI_AttributeRefAttrList.h>
 #include <ModelAPI_AttributeString.h>
 #include <ModelAPI_AttributeIntArray.h>
 #include <ModelAPI_Data.h>
@@ -55,6 +56,8 @@ class Model_Data : public ModelAPI_Data
   std::set<AttributePtr> myRefsToMe;
   /// flag that may block the "attribute updated" sending
   bool mySendAttributeUpdated;
+  /// if some attribute was changed, but mySendAttributeUpdated was false, this stores this
+  std::list<ModelAPI_Attribute*> myWasChangedButBlocked;
 
   /// Returns label of this feature
   TDF_Label label()
@@ -68,7 +71,10 @@ class Model_Data : public ModelAPI_Data
   friend class Model_AttributeReference;
   friend class Model_AttributeRefAttr;
   friend class Model_AttributeRefList;
+  friend class Model_AttributeRefAttrList;
   friend class Model_AttributeSelection;
+  friend class Model_AttributeSelectionList;
+  friend class Model_ValidatorsFactory;
 
  public:
   /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
@@ -81,6 +87,8 @@ class Model_Data : public ModelAPI_Data
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
   /// Returns the attribute that contains real value with double precision
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
+  /// Returns the attribute that contains double values array
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
   /// Returns the attribute that contains integer value
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
     integer(const std::string& theID);
@@ -99,6 +107,10 @@ class Model_Data : public ModelAPI_Data
   /// Returns the attribute that contains list of references to features
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
     reflist(const std::string& theID);
+  /// Returns the attribute that contains list of references to features
+  /// or reference to an attribute of a feature
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
+    refattrlist(const std::string& theID);
   /// Returns the attribute that contains boolean value
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
     boolean(const std::string& theID);
@@ -146,7 +158,11 @@ class Model_Data : public ModelAPI_Data
   /// makes attribute initialized
   MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
   /// Blocks sending "attribute updated" if theBlock is true
-  MODEL_EXPORT virtual void blockSendAttributeUpdated(const bool theBlock);
+  /// \param theBlock allows switching on/off the blocking state
+  /// \param theSendMessage if false, it does not send the update message even if something is changed
+  ///            (normally is it used in attributeChanged because this message will be sent anyway)
+  MODEL_EXPORT virtual void blockSendAttributeUpdated(
+    const bool theBlock, const bool theSendMessage = true);
 
   /// Puts feature to the document data sub-structure
   MODEL_EXPORT void setLabel(TDF_Label theLab);
@@ -169,6 +185,9 @@ class Model_Data : public ModelAPI_Data
   /// Registers error during the execution, causes the ExecutionFailed state
   MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
 
+  /// Erases the error string if it is not empty
+  void eraseErrorString();
+
   /// Registers error during the execution, causes the ExecutionFailed state
   MODEL_EXPORT virtual std::string error() const;
 
@@ -189,6 +208,20 @@ class Model_Data : public ModelAPI_Data
   /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig)
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
 
+  /// Returns the invalid data pointer: static method
+  static std::shared_ptr<ModelAPI_Data> invalidData();
+
+  /// Identifier of the transaction when object (feature or result) was updated last time.
+  MODEL_EXPORT virtual int updateID();
+
+  /// Identifier of the transaction when object (feature or result) was updated last time.
+  /// This method is called by the updater.
+  MODEL_EXPORT virtual void setUpdateID(const int theID);
+
+  /// Returns true if the given object is owner of this data (needed for correct erase of object
+  /// with duplicated data)
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
+
 protected:
   /// Returns true if "is in history" custom behaviors is defined for the feature
   MODEL_EXPORT virtual bool isInHistory();
@@ -196,14 +229,22 @@ protected:
   /// Defines the custom "is in history" behavior
   MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
 
+  /// Returns true if the object is deleted, but some data is still keept in memory
+  MODEL_EXPORT virtual bool isDeleted();
+
+  /// Sets true if the object is deleted, but some data is still keept in memory
+  MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
+
 private:
   /// Removes all information about back references
   void eraseBackReferences();
-  /// Adds a back reference (with identifier which attribute references to this object
-  /// It does not change the consealment flag of the data object result
+  /// Removes a back reference (with identifier which attribute references to this object)
   /// \param theFeature feature referenced to this
   /// \param theAttrID identifier of the attribute that is references from theFeature to this
   void removeBackReference(FeaturePtr theFeature, std::string theAttrID);
+  /// Removes a back reference (by the attribute)
+  /// \param theAttr the referenced attribute
+  void removeBackReference(AttributePtr theAttr);
   /// Adds a back reference (with identifier which attribute references to this object
   /// \param theFeature feature referenced to this
   /// \param theAttrID identifier of the attribute that is references from theFeature to this
@@ -211,6 +252,9 @@ private:
   void addBackReference(FeaturePtr theFeature, std::string theAttrID, 
     const bool theApplyConcealment = true);
 
+  /// Makes the concealment flag up to date for this object-owner.
+  MODEL_EXPORT virtual void updateConcealmentFlag();
+
   /// Returns true if object must be displayed in the viewer: flag is stored in the
   /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
   /// the original state i nthe current transaction.