X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=598c3b633f674c283e69f89c7b1edaff4f75341b;hb=7b76b534d04e5d50f1ad319e58e0e22c6bb742a3;hp=b1e863e3f26eb4e9ae2a5ee573e7f27d57b5d3fb;hpb=b59f7dcc2d937516200929ad5bb183085febd459;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index b1e863e3f..598c3b633 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -2,110 +2,187 @@ // Created: 28 Feb 2014 // Author: Mikhail PONIKAROV -#ifndef Model_Document_HeaderFile -#define Model_Document_HeaderFile +#ifndef Model_Document_H_ +#define Model_Document_H_ #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_Document * \ingroup DataModel - * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study. - * Document contains all data of te SALOME Study specific to this module - * that must be written into the HDF file. + * \brief Document for internal data structure of any object storage. + * Document contains all data that must be stored/retrived in the file. * Also it provides acces to this data: open/save, transactions management etc. - * to provide access to all stored data. */ - -class Model_Document: public ModelAPI_Document +class Model_Document : public ModelAPI_Document { -public: + public: //! 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 bool load(const char* theFileName); + MODEL_EXPORT virtual bool load(const char* theFileName); //! Saves the OCAF document to the file. //! \param theFileName full name of the file to store + //! \param theResults the result full file names that were stored by "save" //! \returns true if file was stored successfully - MODEL_EXPORT bool save(const char* theFileName); + MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); //! Removes document data - MODEL_EXPORT void close(); + MODEL_EXPORT virtual void close(); //! Starts a new operation (opens a tansaction) - MODEL_EXPORT void startOperation(); + MODEL_EXPORT virtual void startOperation(); //! Finishes the previously started operation (closes the transaction) - MODEL_EXPORT void finishOperation(); + //! Returns true if transaction in this document is not empty and really was performed + MODEL_EXPORT virtual void finishOperation(); //! Aborts the operation - MODEL_EXPORT void abortOperation(); + MODEL_EXPORT virtual void abortOperation(); //! Returns true if operation has been started, but not yet finished or aborted - MODEL_EXPORT bool isOperation(); + MODEL_EXPORT virtual bool isOperation(); //! Returns true if document was modified (since creation/opening) - MODEL_EXPORT bool isModified(); + MODEL_EXPORT virtual bool isModified(); //! Returns True if there are available Undos - MODEL_EXPORT bool canUndo(); + MODEL_EXPORT virtual bool canUndo(); //! Undoes last operation - MODEL_EXPORT void undo(); + MODEL_EXPORT virtual void undo(); //! Returns True if there are available Redos - MODEL_EXPORT bool canRedo(); + MODEL_EXPORT virtual bool canRedo(); //! Redoes last operation - MODEL_EXPORT void redo(); + 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); - //! Adds to the document the new feature of the given group id - //! \param theFeature a feature object that will be connected to the document in this method - //! \param theGroupID identifier of the groups of objects (must be greater than zero) - MODEL_EXPORT virtual void addFeature(std::shared_ptr theFeature, - const std::string theGroupID); + //! Removes the feature from the document (with result) + MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature); //! Returns the existing feature by the label //! \param theLabel base label of the feature - MODEL_EXPORT virtual std::shared_ptr feature(TDF_Label& theLabel); + MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel); + + //! 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); + MODEL_EXPORT virtual boost::shared_ptr subDocument(std::string theDocID); - //! Creates an iterator of the features by the specific groups - MODEL_EXPORT virtual std::shared_ptr featuresIterator( - const std::string theGroup); + //! Internal sub-document by ID + MODEL_EXPORT virtual boost::shared_ptr subDoc(std::string theDocID); - MODEL_EXPORT virtual const std::string& id() const {return myID;} + ///! Returns the id of hte document + MODEL_EXPORT virtual const std::string& id() const + { + return myID; + } //! Returns the feature in the group by the index (started from zero) - MODEL_EXPORT virtual std::shared_ptr - feature(const std::string& theGroupID, const int theIndex); - - ///! Returns the vector of groups already added to the document - MODEL_EXPORT virtual const std::vector& getGroups() const; - -protected: - - //! Returns (creates if needed) the group label - TDF_Label groupLabel(const std::string theGroup); + //! \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); + + //! 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); + + /// Creates a construction cresults + MODEL_EXPORT virtual boost::shared_ptr createConstruction( + const boost::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); + /// Creates a part results + MODEL_EXPORT virtual boost::shared_ptr createPart( + const boost::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); + + ///! 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;} + + protected: + + //! Returns (creates if needed) the features label + TDF_Label featuresLabel(); //! Initializes feature with a unique name in this group (unique name is generated as //! feature type + "_" + index - void setUniqueName( - std::shared_ptr theFeature, const std::string theGroupID); + void setUniqueName(FeaturePtr theFeature); + + //! Synchronizes myFeatures list with the updated document + void synchronizeFeatures(const bool theMarkUpdated = false); //! Creates new document with binary file format Model_Document(const std::string theID); - friend class Model_Application; + Handle_TDocStd_Document document() + { + return myDoc; + } + + //! performas compactification of all nested operations into one + void compactNested(); + + //! Initializes the data fields of the feature + void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag); -private: - std::string myID; ///< identifier of the document in the application - Handle_TDocStd_Document myDoc; ///< OCAF document - int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method - std::map myGroups; ///< root labels of the features groups identified by names - std::vector myGroupsNames; ///< names of added groups to the document + //! 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, + 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); + + //! Updates the results list of the feature basing on the current data tree + void updateResults(FeaturePtr theFeature); + + friend class Model_Application; + friend class Model_Session; + friend class DFBrowser; + + private: + std::string myID; ///< identifier 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; + /// 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; + /// If it is true, features are not executed on update (on abort, undo, redo) + bool myExecuteFeatures; }; #endif