X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=0b7a618c68119b59f67e47c7a181e98639b7c256;hb=4b4154e06aba65daeab5178a0ac3998c8383318a;hp=6d5d04b6babd0c0dacc596fcae00a1e9ddda8774;hpb=61ca3befeb43f693d0b93593268720faca2d121b;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 6d5d04b6b..0b7a618c6 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -2,27 +2,39 @@ // 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. * Document contains all data that must be stored/retrived in the file. * Also it provides acces to this data: open/save, transactions management etc. */ -class Model_Document: public ModelAPI_Document +class Model_Document : public ModelAPI_Document { -public: + public: + //! Returns the kind of the document: "PartSet", "Part", or something else. + //! This kind is used for feature buttons enable/disable depending on active document + //! (it uses workbench "document" identifier in XML configuration file for this) + 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 @@ -32,11 +44,13 @@ public: //! 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 virtual bool save(const char* theFileName); + 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(); @@ -61,67 +75,136 @@ public: //! Adds to the document the new feature of the given feature id //! \param creates feature and puts it in the document - MODEL_EXPORT virtual boost::shared_ptr addFeature(std::string theID); + MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID); + + //! 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 boost::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 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 std::shared_ptr subDoc(std::string theDocID); ///! Returns the id of hte document - MODEL_EXPORT virtual const std::string& id() const {return myID;} + 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 boost::shared_ptr - feature(const std::string& theGroupID, const int theIndex); + //! \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 - MODEL_EXPORT virtual int size(const std::string& theGroupID); + //! 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 std::shared_ptr createConstruction( + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a body results + MODEL_EXPORT virtual std::shared_ptr createBody( + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a part results + 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); + + //! Returns a feature by result (owner of result) + 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;} + + protected: + + //! Returns (creates if needed) the features label + TDF_Label featuresLabel(); - ///! Returns the vector of groups already added to the document - MODEL_EXPORT virtual const std::vector& getGroups() const; + //! Initializes feature with a unique name in this group (unique name is generated as + //! feature type + "_" + index + void setUniqueName(FeaturePtr theFeature); - //! Returns the index of feature in the group (zero based) - //! \retruns -1 if not found - MODEL_EXPORT virtual int featureIndex(boost::shared_ptr 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: + //! Creates new document with binary file format + Model_Document(const std::string theID, const std::string theKind); - //! Returns (creates if needed) the group label - TDF_Label groupLabel(const std::string theGroup); + Handle_TDocStd_Document document() + { + return myDoc; + } - //! Initializes feature with a unique name in this group (unique name is generated as - //! feature type + "_" + index - void setUniqueName(boost::shared_ptr theFeature); + //! performs compactification of all nested operations into one + //! \returns true if resulting transaction is not empty and can be undoed + bool compactNested(); - //! Adds to the document the new feature - void addFeature(const boost::shared_ptr theFeature); + //! Initializes the data fields of the feature + void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag); - //! Synchronizes myGroups, myGroupsNames, myFeatures and mySubs list with the updated document - void synchronizeFeatures(); + //! 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); - //! Creates new document with binary file format - Model_Document(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); - friend class Model_Application; + //! Updates the results list of the feature basing on the current data tree + void updateResults(FeaturePtr theFeature); + + //! Returns all sub documents + const std::set& subDocuments() const {return mySubs;} -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 myTransactionsAfterSave for the nested transaction start - int myNestedStart; - /// root labels of the features groups identified by names - std::map myGroups; - std::vector myGroupsNames; ///< names of added groups to the document - /// Features managed by this document: by group name - std::map > > myFeatures; - std::set mySubs; ///< set of identifiers of sub-documents of this document + friend class Model_Application; + friend class Model_Session; + friend class Model_Update; + friend class Model_AttributeReference; + friend class DFBrowser; + + private: + 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; + /// 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