1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Document.h
4 // Created: 28 Feb 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef Model_Document_H_
8 #define Model_Document_H_
11 #include <ModelAPI_Document.h>
12 #include <ModelAPI_Feature.h>
13 #include <ModelAPI_Result.h>
15 #include <TDocStd_Document.hxx>
16 #include <NCollection_DataMap.hxx>
17 #include <TDF_Label.hxx>
21 class Handle_Model_Document;
23 // for TDF_Label map usage
24 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
25 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
27 /**\class Model_Document
29 * \brief Document for internal data structure of any object storage.
30 * Document contains all data that must be stored/retrived in the file.
31 * Also it provides acces to this data: open/save, transactions management etc.
33 class Model_Document : public ModelAPI_Document
36 //! Returns the kind of the document: "PartSet", "Part", or something else.
37 //! This kind is used for feature buttons enable/disable depending on active document
38 //! (it uses workbench "document" identifier in XML configuration file for this)
39 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
41 //! Loads the OCAF document from the file.
42 //! \param theFileName full name of the file to load
43 //! \param theStudyID identifier of the SALOME study to associate with loaded file
44 //! \returns true if file was loaded successfully
45 MODEL_EXPORT virtual bool load(const char* theFileName);
47 //! Saves the OCAF document to the file.
48 //! \param theFileName full name of the file to store
49 //! \param theResults the result full file names that were stored by "save"
50 //! \returns true if file was stored successfully
51 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
53 //! Removes document data
54 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
55 MODEL_EXPORT virtual void close(const bool theForever = false);
57 //! Starts a new operation (opens a tansaction)
58 MODEL_EXPORT virtual void startOperation();
59 //! Finishes the previously started operation (closes the transaction)
60 //! Returns true if transaction in this document is not empty and really was performed
61 MODEL_EXPORT virtual void finishOperation();
62 //! Aborts the operation
63 MODEL_EXPORT virtual void abortOperation();
64 //! Returns true if operation has been started, but not yet finished or aborted
65 MODEL_EXPORT virtual bool isOperation();
66 //! Returns true if document was modified (since creation/opening)
67 MODEL_EXPORT virtual bool isModified();
69 //! Returns True if there are available Undos
70 MODEL_EXPORT virtual bool canUndo();
71 //! Undoes last operation
72 MODEL_EXPORT virtual void undo();
73 //! Returns True if there are available Redos
74 MODEL_EXPORT virtual bool canRedo();
75 //! Redoes last operation
76 MODEL_EXPORT virtual void redo();
78 //! Adds to the document the new feature of the given feature id
79 //! \param creates feature and puts it in the document
80 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
82 //! Removes the feature from the document (with result)
83 //! \param theCheck if it is false, do not check the references
84 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature, const bool theCheck = true);
86 //! Returns the existing feature by the label
87 //! \param theLabel base label of the feature
88 MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel);
90 //! Returns the existing object: result or feature
91 //! \param theLabel base label of the object
92 MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
94 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
95 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
97 //! Internal sub-document by ID
98 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(std::string theDocID);
100 ///! Returns the id of hte document
101 MODEL_EXPORT virtual const std::string& id() const
106 //! Returns the feature in the group by the index (started from zero)
107 //! \param theGroupID group that contains a feature
108 //! \param theIndex zero-based index of feature in the group
109 //! \param isOperation if it is true, returns feature (not Object)
110 //! \param theHidden if it is true, it counts also the features that are not in tree
111 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
112 const bool theHidden = false);
114 //! Returns the number of features in the group
115 //! If theHidden is true, it counts also the features that are not in tree
116 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
118 /// Creates a construction cresults
119 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
120 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
121 /// Creates a body results
122 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
123 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
124 /// Creates a part results
125 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
126 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
127 /// Creates a group results
128 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
129 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
131 //! Returns a feature by result (owner of result)
132 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
133 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
135 ///! Returns true if parametric updater need to execute feature on recomputartion
136 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
137 bool executeFeatures() {return myExecuteFeatures;}
139 //! Registers the name of the shape for the topological naming needs
140 void addNamingName(const TDF_Label theLabel, std::string theName);
141 //! Returns the label, keeper of the name for the topological naming needs
142 TDF_Label findNamingName(std::string theName);
146 //! Returns (creates if needed) the features label
147 TDF_Label featuresLabel();
149 //! Initializes feature with a unique name in this group (unique name is generated as
150 //! feature type + "_" + index
151 void setUniqueName(FeaturePtr theFeature);
153 //! Synchronizes myFeatures list with the updated document
154 //! \param theMarkUpdated causes the "update" event for all features
155 //! \param theUpdateReferences causes the update of back-references
156 void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences);
157 //! Synchronizes the BackReferences list in Data of Features and Results
158 void synchronizeBackRefs();
160 //! Creates new document with binary file format
161 Model_Document(const std::string theID, const std::string theKind);
163 Handle_TDocStd_Document document()
168 //! performs compactification of all nested operations into one
169 //! \returns true if resulting transaction is not empty and can be undoed
170 bool compactNested();
172 //! Initializes the data fields of the feature
173 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
175 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
176 MODEL_EXPORT virtual void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
177 std::shared_ptr<ModelAPI_Result> theResult,
178 const int theResultIndex = 0);
180 //! returns the label of result by index; creates this label if it was not created before
181 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
183 //! Updates the results list of the feature basing on the current data tree
184 void updateResults(FeaturePtr theFeature);
186 //! Returns all sub documents
187 const std::set<std::string>& subDocuments() const {return mySubs;}
189 friend class Model_Application;
190 friend class Model_Session;
191 friend class Model_Update;
192 friend class Model_AttributeReference;
193 friend class DFBrowser;
196 std::string myID; ///< identifier of the document in the application
197 std::string myKind; ///< kind of the document in the application
198 Handle_TDocStd_Document myDoc; ///< OCAF document
199 /// counter of transactions
200 int myTransactionsCounter;
201 /// counter value of transaction on the last "save" call, used for "IsModified" method
202 int myTransactionSave;
203 /// number of nested transactions performed (or -1 if not nested)
205 /// All features managed by this document (not only in history of OB)
206 /// For optimization mapped by labels
207 NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
208 /// Optimization for finding the shape-label by topological naming names
209 std::map<std::string, TDF_Label> myNamingNames;
211 ///< set of identifiers of sub-documents of this document
212 std::set<std::string> mySubs;
213 /// transaction indexes (related to myTransactionsAfterSave) which were empty in this doc
214 std::map<int, bool> myIsEmptyTr;
215 /// If it is true, features are not executed on update (on abort, undo, redo)
216 bool myExecuteFeatures;