1 // File: Model_Document.h
2 // Created: 28 Feb 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef Model_Document_H_
6 #define Model_Document_H_
9 #include <ModelAPI_Document.h>
10 #include <ModelAPI_Feature.h>
11 #include <ModelAPI_Result.h>
13 #include <TDocStd_Document.hxx>
14 #include <NCollection_DataMap.hxx>
15 #include <TDF_Label.hxx>
19 class Handle_Model_Document;
21 // for TDF_Label map usage
22 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
23 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
25 /**\class Model_Document
27 * \brief Document for internal data structure of any object storage.
28 * Document contains all data that must be stored/retrived in the file.
29 * Also it provides acces to this data: open/save, transactions management etc.
31 class Model_Document : public ModelAPI_Document
35 //! Loads the OCAF document from the file.
36 //! \param theFileName full name of the file to load
37 //! \param theStudyID identifier of the SALOME study to associate with loaded file
38 //! \returns true if file was loaded successfully
39 MODEL_EXPORT virtual bool load(const char* theFileName);
41 //! Saves the OCAF document to the file.
42 //! \param theFileName full name of the file to store
43 //! \returns true if file was stored successfully
44 MODEL_EXPORT virtual bool save(const char* theFileName);
46 //! Removes document data
47 MODEL_EXPORT virtual void close();
49 //! Starts a new operation (opens a tansaction)
50 MODEL_EXPORT virtual void startOperation();
51 //! Finishes the previously started operation (closes the transaction)
52 //! Returns true if transaction in this document is not empty and really was performed
53 MODEL_EXPORT virtual void finishOperation();
54 //! Aborts the operation
55 MODEL_EXPORT virtual void abortOperation();
56 //! Returns true if operation has been started, but not yet finished or aborted
57 MODEL_EXPORT virtual bool isOperation();
58 //! Returns true if document was modified (since creation/opening)
59 MODEL_EXPORT virtual bool isModified();
61 //! Returns True if there are available Undos
62 MODEL_EXPORT virtual bool canUndo();
63 //! Undoes last operation
64 MODEL_EXPORT virtual void undo();
65 //! Returns True if there are available Redos
66 MODEL_EXPORT virtual bool canRedo();
67 //! Redoes last operation
68 MODEL_EXPORT virtual void redo();
70 //! Adds to the document the new feature of the given feature id
71 //! \param creates feature and puts it in the document
72 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
74 //! Removes the feature from the document (with result)
75 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
77 //! Returns the existing feature by the label
78 //! \param theLabel base label of the feature
79 MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel);
81 //! Returns the existing object: result or feature
82 //! \param theLabel base label of the object
83 MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
85 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
86 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
88 ///! Returns the id of hte document
89 MODEL_EXPORT virtual const std::string& id() const
94 //! Returns the feature in the group by the index (started from zero)
95 //! \param theGroupID group that contains a feature
96 //! \param theIndex zero-based index of feature in the group
97 //! \param isOperation if it is true, returns feature (not Object)
98 //! \param theHidden if it is true, it counts also the features that are not in tree
99 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
100 const bool theHidden = false);
102 //! Returns the number of features in the group
103 //! If theHidden is true, it counts also the features that are not in tree
104 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
106 /// Creates a construction cresults
107 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
108 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
109 /// Creates a body results
110 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultBody> createBody(
111 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
112 /// Creates a part results
113 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultPart> createPart(
114 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
116 //! Returns a feature by result (owner of result)
117 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature>
118 feature(const boost::shared_ptr<ModelAPI_Result>& theResult);
120 ///! Returns true if parametric updater need to execute feature on recomputartion
121 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
122 bool executeFeatures() {return myExecuteFeatures;}
126 //! Returns (creates if needed) the features label
127 TDF_Label featuresLabel();
129 //! Initializes feature with a unique name in this group (unique name is generated as
130 //! feature type + "_" + index
131 void setUniqueName(FeaturePtr theFeature);
133 //! Synchronizes myFeatures list with the updated document
134 void synchronizeFeatures(const bool theMarkUpdated = false);
136 //! Creates new document with binary file format
137 Model_Document(const std::string theID);
139 Handle_TDocStd_Document document()
144 //! performas compactification of all nested operations into one
145 void compactNested();
147 //! Initializes the data fields of the feature
148 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
150 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
151 MODEL_EXPORT virtual void storeResult(boost::shared_ptr<ModelAPI_Data> theFeatureData,
152 boost::shared_ptr<ModelAPI_Result> theResult,
153 const int theResultIndex = 0);
155 //! returns the label of result by index; creates this label if it was not created before
156 TDF_Label Model_Document::resultLabel(
157 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
159 //! Updates the results list of the feature basing on the current data tree
160 void updateResults(FeaturePtr theFeature);
162 friend class Model_Application;
163 friend class Model_PluginManager;
164 friend class DFBrowser;
167 std::string myID; ///< identifier of the document in the application
168 Handle_TDocStd_Document myDoc; ///< OCAF document
169 /// number of transactions after the last "save" call, used for "IsModified" method
170 int myTransactionsAfterSave;
171 /// number of nested transactions performed (or -1 if not nested)
173 /// All features managed by this document (not only in history of OB)
174 /// For optimization mapped by labels
175 NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
177 ///< set of identifiers of sub-documents of this document
178 std::set<std::string> mySubs;
179 /// transaction indexes (related to myTransactionsAfterSave) which were empty in this doc
180 std::map<int, bool> myIsEmptyTr;
181 /// If it is true, features are not executed on update (on abort, undo, redo)
182 bool myExecuteFeatures;