X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=453422ffcf9900e7f3cf846c1dd3ece339a3f5e8;hb=6a7e53a3d3b52f1f798b7e3aa3c48de9c870d92b;hp=6f813bd231da45a6b72917c1b7cb508605c3259f;hpb=53df1b33d7d3787a433f8e4f3936eed28850c48b;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 6f813bd23..453422ffc 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 @@ -9,6 +11,7 @@ #include #include #include +#include #include #include @@ -38,7 +41,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); @@ -49,17 +51,18 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); //! Removes document data - MODEL_EXPORT virtual void close(); + //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo) + MODEL_EXPORT virtual void close(const bool theForever = false); //! 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(); @@ -73,26 +76,42 @@ 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 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 boost::shared_ptr subDocument(std::string theDocID); + MODEL_EXPORT virtual std::shared_ptr subDocument(std::string theDocID); //! Internal sub-document by ID - MODEL_EXPORT virtual boost::shared_ptr subDoc(std::string theDocID); + MODEL_EXPORT virtual std::shared_ptr subDoc(std::string theDocID); ///! Returns the id of hte document MODEL_EXPORT virtual const std::string& id() const @@ -103,7 +122,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); @@ -113,44 +131,59 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false); /// Creates a construction cresults - MODEL_EXPORT virtual boost::shared_ptr createConstruction( - const boost::shared_ptr& theFeatureData, const int theIndex = 0); + MODEL_EXPORT virtual std::shared_ptr createConstruction( + const std::shared_ptr& theFeatureData, const int theIndex = 0); /// Creates a body results - MODEL_EXPORT virtual boost::shared_ptr createBody( - const boost::shared_ptr& theFeatureData, const int theIndex = 0); + MODEL_EXPORT virtual std::shared_ptr createBody( + const std::shared_ptr& theFeatureData, const int theIndex = 0); /// Creates a part results - MODEL_EXPORT virtual boost::shared_ptr createPart( - const boost::shared_ptr& theFeatureData, const int theIndex = 0); + MODEL_EXPORT virtual std::shared_ptr createPart( + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a group results + 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 boost::shared_ptr - feature(const boost::shared_ptr& theResult); + MODEL_EXPORT virtual std::shared_ptr + feature(const std::shared_ptr& theResult); ///! Returns true if parametric updater need to execute feature on recomputartion ///! On abort, undo or redo it is not necessary: results in document are updated automatically bool executeFeatures() {return myExecuteFeatures;} - ///! Reutrns true is result was conecaled because of usage it by other object - virtual bool isConcealed(const boost::shared_ptr& theResult) { - return myConcealedResults.find(boost::dynamic_pointer_cast(theResult)) - != myConcealedResults.end(); - } + //! 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 void setUniqueName(FeaturePtr theFeature); //! Synchronizes myFeatures list with the updated document - void synchronizeFeatures(const bool theMarkUpdated = false); + //! \param theMarkUpdated causes the "update" event for all features + //! \param theUpdateReferences causes the update of back-references + //! \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(); //! 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; @@ -158,32 +191,46 @@ 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); //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree) - MODEL_EXPORT virtual void storeResult(boost::shared_ptr theFeatureData, - boost::shared_ptr theResult, + MODEL_EXPORT virtual void storeResult(std::shared_ptr theFeatureData, + std::shared_ptr theResult, const int theResultIndex = 0); //! returns the label of result by index; creates this label if it was not created before - TDF_Label resultLabel(const boost::shared_ptr& theFeatureData, const int theResultIndex); + TDF_Label resultLabel(const std::shared_ptr& theFeatureData, const int theResultIndex); //! Updates the results list of the feature basing on the current data tree void updateResults(FeaturePtr theFeature); - //! Stores information that there is a reference to this object - void objectIsReferenced(const ObjectPtr& theObject); - //! Removes information that there is a reference to this object - void objectIsNotReferenced(const ObjectPtr& theObject); - //! 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); + + //! 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; + friend class Model_Update; friend class Model_AttributeReference; friend class DFBrowser; @@ -191,20 +238,31 @@ 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 - /// number of transactions after the last "save" call, used for "IsModified" method - int myTransactionsAfterSave; - /// number of nested transactions performed (or -1 if not nested) - int myNestedNum; + + /// counter value of transaction on the last "save" call, used for "IsModified" method + int myTransactionSave; + /// 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; + + /// 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 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; - /// Results that are referenced and must be concealed for object browser - std::set myConcealedResults; - - ///< 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; };