X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=67e48301e9fca54d78df0138c05b2875d51de8c8;hb=1c530eba1d76c012cfc61df1c21694e62f203d94;hp=56490a15c337b60a825b729215da58567411df97;hpb=4bf5c624e120ef5b7fca9625f8fdc23fbdfefc25;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 56490a15c..67e48301e 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: Model_Document.h -// Created: 28 Feb 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// #ifndef Model_Document_H_ #define Model_Document_H_ @@ -11,18 +25,15 @@ #include #include #include +#include #include -#include -#include #include #include class Handle_Model_Document; - -// for TDF_Label map usage -static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper); -static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2); +class Model_Objects; +class ModelAPI_AttributeSelectionList; /**\class Model_Document * \ingroup DataModel @@ -39,30 +50,35 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual const std::string& kind() const {return myKind;} //! 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 + //! \param theDirName directory of the loaded file + //! \param theFileName a name of the file to load + //! \param theThis the common shared pointer to the document to manage with it later //! \returns true if file was loaded successfully - MODEL_EXPORT virtual bool load(const char* theFileName); + MODEL_EXPORT virtual bool load( + const char* theDirName, const char* theFileName, DocumentPtr theThis); //! Saves the OCAF document to the file. - //! \param theFileName full name of the file to store + //! \param theDirName directory where the document will be saved + //! \param theFileName a name of the document file to store //! \param theResults the result full file names that were stored by "save" //! \returns true if file was stored successfully - MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); + MODEL_EXPORT virtual bool save( + const char* theDirName, const char* theFileName, std::list& theResults); //! Removes document data - //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo) + //! \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(); - //! Aborts the operation + //! \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(); @@ -76,29 +92,44 @@ 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 - MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID); + //! \param theID creates feature and puts it in the document + //! \param theMakeCurrent to make current this new feature in this document + MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true); + + //! 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); - - //! Returns the existing feature by the label - //! \param theLabel base label of the feature - 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); - - //! 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); + //! It is necessary to flush REDISPLAY signal manually after this method because + //! the method sends it, but for the performance purpose does not flush it + //! \param theFeature a removed feature + MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature); + + //! Moves the feature to make it after the given one in the history. + MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis); + + //! 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); + + //! Returns the object index in the group. Object must be visible. Otherwise returns -1. + //! \param theObject object of this document + //! \returns index started from zero, or -1 if object is invisible or belongs to another document + MODEL_EXPORT virtual const int index(std::shared_ptr theObject); //! Internal sub-document by ID - MODEL_EXPORT virtual std::shared_ptr subDoc(std::string theDocID); + MODEL_EXPORT virtual std::shared_ptr subDoc(int theDocID); - ///! Returns the id of hte document - MODEL_EXPORT virtual const std::string& id() const + ///! Returns the id of the document + MODEL_EXPORT virtual const int id() const { return myID; } @@ -106,14 +137,40 @@ 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); + MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex); //! Returns the number of features in the group - //! If theHidden is true, it counts also the features that are not in tree - MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false); + MODEL_EXPORT virtual int size(const std::string& theGroupID); + + //! Returns the feature that is currently edited in this document, normally + //! this is the latest created feature + //! \param theVisible use visible features only: flag is true for Object Browser functionality + //! \returns null if next created feature must be the first + MODEL_EXPORT virtual std::shared_ptr currentFeature(const bool theVisible); + + //! Sets the current feature: all features below will be disabled, new features + //! will be appended after this one. + //! \param theCurrent the selected feature as current: below it everything becomes disabled + //! \param theVisible use visible features only: flag is true for Object Browser functionality + MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr theCurrent, + const bool theVisible); + + //! Makes the current feature one feature upper + MODEL_EXPORT virtual void setCurrentFeatureUp(); + + //! Returns the number of all features: in the history or not + MODEL_EXPORT virtual int numInternalFeatures(); + //! Returns the feature by zero-based index: features in the history or not + MODEL_EXPORT virtual std::shared_ptr internalFeature(const int theIndex); + //! Performs synchronization of transactions with the module document: + //! If some document is not active (by undo of activation) but in memory, + //! on activation the transactions must be synchronised because all redos performed + //! wihtout this participation + MODEL_EXPORT virtual void synchronizeTransactions(); + + //! Returns feature by the id of the feature (produced by the Data "featureId" method) + MODEL_EXPORT virtual std::shared_ptr featureById(const int theId); + /// Creates a construction cresults MODEL_EXPORT virtual std::shared_ptr createConstruction( @@ -124,9 +181,19 @@ class Model_Document : public ModelAPI_Document /// Creates a part results MODEL_EXPORT virtual std::shared_ptr createPart( const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a group results + //! Copies a part result, keeping the reference to origin + MODEL_EXPORT virtual std::shared_ptr copyPart( + const std::shared_ptr& theOrigin, + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a group result MODEL_EXPORT virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a field result + MODEL_EXPORT virtual std::shared_ptr createField( + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a parameter result + 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 @@ -134,35 +201,56 @@ class Model_Document : public ModelAPI_Document ///! 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;} + bool& executeFeatures() {return myExecuteFeatures;} //! Registers the name of the shape for the topological naming needs void addNamingName(const TDF_Label theLabel, std::string theName); + //! Updates the name of some object + void changeNamingName(std::string theOldName, const std::string theNewName); //! 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 all features of the document including the hidden features which are not in + ///! history. Not very fast method, for calling once, not in big cycles. + MODEL_EXPORT virtual std::list > allFeatures(); + + /// Returns the global identifier of the current transaction (needed for the update algo) + MODEL_EXPORT virtual int transactionID(); + /// Increases the transaction ID + MODEL_EXPORT virtual void incrementTransactionID(); + /// Decreases the transaction ID + MODEL_EXPORT virtual void decrementTransactionID(); + + /// Returns true if document is opened and valid + MODEL_EXPORT virtual bool isOpened(); + + /// Returns the last feature in the document (even not visible or disabled) + /// \returns null if there is no features + FeaturePtr lastFeature(); + + /// Returns the feature that produced the given face of the given result. + MODEL_EXPORT virtual std::shared_ptr producedByFeature( + std::shared_ptr theResult, + const std::shared_ptr& theShape); + + /// Returns true if theLater is in history of features creation later than theCurrent + MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const; - //! Returns (creates if needed) the features label - TDF_Label featuresLabel() const; + /// Just removes all features without touching the document data (to be able undo) + MODEL_EXPORT virtual void eraseAllFeatures(); - //! 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 - //! \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); - //! Synchronizes the BackReferences list in Data of Features and Results - void synchronizeBackRefs(); + protected: + //! Returns (creates if needed) the general label + TDF_Label generalLabel() const; //! Creates new document with binary file format - Model_Document(const std::string theID, const std::string theKind); + Model_Document(const int theID, const std::string theKind); + //! Returns the internal OCCT document of this interface Handle_TDocStd_Document document() { return myDoc; @@ -172,55 +260,105 @@ class Model_Document : public ModelAPI_Document //! \returns true if resulting transaction is not empty and can be undoed void compactNested(); - //! Initializes the data fields of the feature - void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag); + //! Returns all loaded sub documents + const std::set subDocuments() const; + + //! The implementation of undo: with or without recoursive calls in the sub-documents + void undoInternal(const bool theWithSubs, const bool theSynchronize); - //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree) - MODEL_EXPORT virtual void storeResult(std::shared_ptr theFeatureData, - std::shared_ptr theResult, - const int theResultIndex = 0); + //! Stores the Id of the current operation (normally is called for the root document) + void operationId(const std::string& theId); - //! returns the label of result by index; creates this label if it was not created before - TDF_Label resultLabel(const std::shared_ptr& theFeatureData, const int theResultIndex); + //! Returns the list of Ids of the operations that can be undoed (called for the root document) + std::list undoList() const; - //! Updates the results list of the feature basing on the current data tree - void updateResults(FeaturePtr theFeature); + //! Returns the list of Ids of the operations that can be redoed (called for the root document) + std::list redoList() const; - //! Returns all sub documents - const std::set subDocuments(const bool theActivatedOnly) const; + //! Internally makes document know that feature was removed or added in history after creation + virtual void updateHistory(const std::shared_ptr theObject); + //! Internally makes document know that feature was removed or added in history after creation + virtual void updateHistory(const std::string theGroup); - //! The implementation of undo: with or without recoursive calls in the sub-documents - void undoInternal(const bool theWithSubs); + //! Returns true if the document is root module document + bool isRoot() const; + + //! Sets shared pointer to this + void setThis(DocumentPtr theDoc); + + //! Returns the objects manager + Model_Objects* objects() {return myObjs;} + + ///! Informs the document that it becomes active and some actions must be performed + virtual void setActive(const bool theFlag); + //! Returns true if this document is currently active + virtual bool isActive() const; + + //! Returns the selection attribute that is used + //! for calculation of selection externally from the document + std::shared_ptr selectionInPartFeature(); + + /// Stores in the document boolean flags: states of the nodes in the object browser. + /// Normally is called outside of the transaction, just before "save". + virtual void storeNodesState(const std::list& theStates); + + /// Returns the stored nodes states. Normally it is calles just after "open". + /// Appends the values to theStates list. + virtual void restoreNodesState(std::list& theStates) const; + + /// Label that constains structures for selection of constructions of another document + TDF_Label extConstructionsLabel() const; friend class Model_Application; friend class Model_Session; friend class Model_Update; friend class Model_AttributeReference; + friend class Model_AttributeRefAttr; + friend class Model_AttributeRefList; + friend class Model_AttributeRefAttrList; + friend class Model_AttributeSelection; + friend class Model_ResultPart; + friend class Model_ResultCompSolid; + friend class Model_ResultConstruction; + friend class Model_SelectionNaming; friend class DFBrowser; private: - std::string myID; ///< identifier of the document in the application + int 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 value of transaction on the last "save" call, used for "IsModified" method + Model_Objects *myObjs; ///< data manager of this document + + //! 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 + //! 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; - /// Optimization for finding the shape-label by topological naming names + //! 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; + + //! 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) + //! If it is true, features are not executed on update (on abort, undo, redo) bool myExecuteFeatures; + + bool myIsActive; ///< flag that stores the active/not active state + + //! The selection feature, if needed + FeaturePtr mySelectionFeature; }; #endif