X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=453422ffcf9900e7f3cf846c1dd3ece339a3f5e8;hb=6a7e53a3d3b52f1f798b7e3aa3c48de9c870d92b;hp=f57349d7e19a77802835904792fa6fc4ce60cd60;hpb=5c861257d29de904a1418488b65e6100cd078433;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index f57349d7e..453422ffc 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -11,6 +11,7 @@ #include #include #include +#include #include #include @@ -56,12 +57,12 @@ class Model_Document : public ModelAPI_Document //! Starts a new operation (opens a tansaction) MODEL_EXPORT virtual void startOperation(); //! Finishes the previously started operation (closes the transaction) - //! Returns true if transaction in this document is not empty and really was performed - MODEL_EXPORT virtual void finishOperation(); + //! \returns true if transaction in this document is not empty and really was performed + MODEL_EXPORT virtual bool finishOperation(); //! Aborts the operation MODEL_EXPORT virtual void abortOperation(); //! Returns true if operation has been started, but not yet finished or aborted - MODEL_EXPORT virtual bool isOperation(); + MODEL_EXPORT virtual bool isOperation() const; //! Returns true if document was modified (since creation/opening) MODEL_EXPORT virtual bool isModified(); @@ -78,10 +79,17 @@ class Model_Document : public ModelAPI_Document //! \param theID creates feature and puts it in the document MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID); + //! Return a list of features, which refers to the feature + //! \param theFeature a feature + //! \param theRefs a list of reference features + //! \param isSendError a flag whether the error message should be send + MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature, + std::set& theRefs, + const bool isSendError = true); + //! Removes the feature from the document (with result) - //! \param theFeature the feature to be removed - //! \param theCheck if it is false, do not check the references - MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature, const bool theCheck = true); + //! \param theFeature a removed feature + MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature); //! Returns the existing feature by the label //! \param theLabel base label of the feature @@ -91,6 +99,14 @@ class Model_Document : public ModelAPI_Document //! \param theLabel base label of the object MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel); + //! Returns the first found object in the group by the object name + //! \param theGroupID group that contains an object + //! \param theName name of the object to search + //! \returns null if such object is not found + MODEL_EXPORT virtual std::shared_ptr objectByName( + const std::string& theGroupID, const std::string& theName); + + //! Adds a new sub-document by the identifier, or returns existing one if it is already exist MODEL_EXPORT virtual std::shared_ptr subDocument(std::string theDocID); @@ -127,6 +143,9 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0); + MODEL_EXPORT virtual std::shared_ptr createParameter( + const std::shared_ptr& theFeatureData, const int theIndex = 0); + //! Returns a feature by result (owner of result) MODEL_EXPORT virtual std::shared_ptr feature(const std::shared_ptr& theResult); @@ -155,7 +174,9 @@ class Model_Document : public ModelAPI_Document //! Synchronizes myFeatures list with the updated document //! \param theMarkUpdated causes the "update" event for all features //! \param theUpdateReferences causes the update of back-references - void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences); + //! \param theFlush makes flush all events in the end of all modifications of this method + void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences, + const bool theFlush); //! Synchronizes the BackReferences list in Data of Features and Results void synchronizeBackRefs(); @@ -190,7 +211,22 @@ class Model_Document : public ModelAPI_Document const std::set subDocuments(const bool theActivatedOnly) const; //! The implementation of undo: with or without recoursive calls in the sub-documents - void undoInternal(const bool theWithSubs); + void undoInternal(const bool theWithSubs, const bool theSynchronize); + + //! Stores the Id of the current operation (normally is called for the root document) + void operationId(const std::string& theId); + + //! Returns the list of Ids of the operations that can be undoed (called for the root document) + std::list undoList() const; + + //! Returns the list of Ids of the operations that can be redoed (called for the root document) + std::list redoList() const; + + /// Internally makes document know that feature was removed or added in history after creation + MODEL_EXPORT virtual void addToHistory(const std::shared_ptr theObject); + + /// Returns true if the document is root module document + bool isRoot() const; friend class Model_Application; friend class Model_Session; @@ -209,11 +245,19 @@ class Model_Document : public ModelAPI_Document /// the list is empty if not nested transaction is performed std::list myNestedNum; - /// transaction indexes (related to myTransactionsAfterSave) and number of real transactions + /// Information related to the every user-transaction + struct Transaction { + int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0 + std::string myId; ///< user-identifier string of transaction + /// default constructor with default Id + Transaction(): myOCAFNum(0), myId("") {} + }; + + /// transaction indexes (related to myTransactionsAfterSave) and info about the real transactions /// in myDocument connected to this operation (may be zero for empty transaction) - std::list myTransactions; - /// list of numbers of real document transactions undone (first is oldest undone) - std::list myRedos; + std::list myTransactions; + /// list of info about transactions undone (first is oldest undone) + std::list myRedos; /// All features managed by this document (not only in history of OB) /// For optimization mapped by labels NCollection_DataMap myObjs;