X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=cb99181f9ddb8a9ce6b1d2233d0f6c508701edb6;hb=46a28bd54e9ce0937d87d305202ab6912c1f5cd2;hp=0b7a618c68119b59f67e47c7a181e98639b7c256;hpb=4b1c827abfbf7af9359088dce8f80692d4d33602;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 0b7a618c6..cb99181f9 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: Model_Document.h // Created: 28 Feb 2014 // Author: Mikhail PONIKAROV @@ -38,7 +40,6 @@ class Model_Document : public ModelAPI_Document //! Loads the OCAF document from the file. //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file //! \returns true if file was loaded successfully MODEL_EXPORT virtual bool load(const char* theFileName); @@ -55,8 +56,8 @@ 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 @@ -74,16 +75,24 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual void redo(); //! Adds to the document the new feature of the given feature id - //! \param creates feature and puts it in the 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 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 - MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel); + MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel) const; //! Returns the existing object: result or feature //! \param theLabel base label of the object @@ -104,7 +113,6 @@ class Model_Document : public ModelAPI_Document //! Returns the feature in the group by the index (started from zero) //! \param theGroupID group that contains a feature //! \param theIndex zero-based index of feature in the group - //! \param isOperation if it is true, returns feature (not Object) //! \param theHidden if it is true, it counts also the features that are not in tree MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex, const bool theHidden = false); @@ -134,10 +142,18 @@ class Model_Document : public ModelAPI_Document ///! On abort, undo or redo it is not necessary: results in document are updated automatically bool executeFeatures() {return myExecuteFeatures;} + //! Registers the name of the shape for the topological naming needs + void addNamingName(const TDF_Label theLabel, std::string theName); + //! Returns the label, keeper of the name for the topological naming needs + TDF_Label findNamingName(std::string theName); + //! Returns the result by name of the result (names of results must be unique, used for naming + //! selection by name. + ResultPtr findByName(const std::string theName); + protected: //! Returns (creates if needed) the features label - TDF_Label featuresLabel(); + TDF_Label featuresLabel() const; //! Initializes feature with a unique name in this group (unique name is generated as //! feature type + "_" + index @@ -153,6 +169,7 @@ class Model_Document : public ModelAPI_Document //! Creates new document with binary file format Model_Document(const std::string theID, const std::string theKind); + //! Returns the internal OCCT document of this interface Handle_TDocStd_Document document() { return myDoc; @@ -160,7 +177,7 @@ class Model_Document : public ModelAPI_Document //! performs compactification of all nested operations into one //! \returns true if resulting transaction is not empty and can be undoed - bool compactNested(); + void compactNested(); //! Initializes the data fields of the feature void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag); @@ -177,7 +194,10 @@ class Model_Document : public ModelAPI_Document void updateResults(FeaturePtr theFeature); //! Returns all sub documents - const std::set& subDocuments() const {return mySubs;} + 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, const bool theSynchronize); friend class Model_Application; friend class Model_Session; @@ -189,20 +209,23 @@ class Model_Document : public ModelAPI_Document std::string myID; ///< identifier of the document in the application std::string myKind; ///< kind of the document in the application Handle_TDocStd_Document myDoc; ///< OCAF document - /// counter of transactions - int myTransactionsCounter; + /// counter value of transaction on the last "save" call, used for "IsModified" method int myTransactionSave; - /// number of nested transactions performed (or -1 if not nested) - int myNestedNum; + /// number of nested transactions performed (list becasue may be nested inside of nested) + /// the list is empty if not nested transaction is performed + std::list myNestedNum; + + /// transaction indexes (related to myTransactionsAfterSave) and number of 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; /// All features managed by this document (not only in history of OB) /// For optimization mapped by labels NCollection_DataMap myObjs; - - ///< set of identifiers of sub-documents of this document - std::set mySubs; - /// transaction indexes (related to myTransactionsAfterSave) which were empty in this doc - std::map myIsEmptyTr; + /// Optimization for finding the shape-label by topological naming names + std::map myNamingNames; /// If it is true, features are not executed on update (on abort, undo, redo) bool myExecuteFeatures; };