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>
14 #include <ModelAPI_ResultParameter.h>
16 #include <TDocStd_Document.hxx>
17 #include <NCollection_DataMap.hxx>
18 #include <TDF_Label.hxx>
22 class Handle_Model_Document;
24 // for TDF_Label map usage
25 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
26 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
28 /**\class Model_Document
30 * \brief Document for internal data structure of any object storage.
31 * Document contains all data that must be stored/retrived in the file.
32 * Also it provides acces to this data: open/save, transactions management etc.
34 class Model_Document : public ModelAPI_Document
37 //! Returns the kind of the document: "PartSet", "Part", or something else.
38 //! This kind is used for feature buttons enable/disable depending on active document
39 //! (it uses workbench "document" identifier in XML configuration file for this)
40 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
42 //! Loads the OCAF document from the file.
43 //! \param theFileName full name of the file to load
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 bool 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() const;
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 theID creates feature and puts it in the document
80 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
82 //! Return a list of features, which refers to the feature
83 //! \param theFeature a feature
84 //! \param theRefs a list of reference features
85 //! \param isSendError a flag whether the error message should be send
86 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
87 std::set<FeaturePtr>& theRefs,
88 const bool isSendError = true);
90 //! Removes the feature from the document (with result)
91 //! \param theFeature a removed feature
92 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
94 //! Returns the existing feature by the label
95 //! \param theLabel base label of the feature
96 MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel) const;
98 //! Returns the existing object: result or feature
99 //! \param theLabel base label of the object
100 MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
102 //! Returns the first found object in the group by the object name
103 //! \param theGroupID group that contains an object
104 //! \param theName name of the object to search
105 //! \returns null if such object is not found
106 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
107 const std::string& theGroupID, const std::string& theName);
109 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
110 //! \param theObject object of this document
111 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
112 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject);
114 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
115 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
117 //! Internal sub-document by ID
118 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(std::string theDocID);
120 ///! Returns the id of hte document
121 MODEL_EXPORT virtual const std::string& id() const
126 //! Returns the feature in the group by the index (started from zero)
127 //! \param theGroupID group that contains a feature
128 //! \param theIndex zero-based index of feature in the group
129 //! \param theHidden if it is true, it counts also the features that are not in tree
130 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
131 const bool theHidden = false);
133 //! Returns the number of features in the group
134 //! If theHidden is true, it counts also the features that are not in tree
135 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
137 /// Creates a construction cresults
138 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
139 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
140 /// Creates a body results
141 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
142 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
143 /// Creates a part results
144 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
145 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
146 /// Creates a group results
147 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
148 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
150 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
151 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
153 //! Returns a feature by result (owner of result)
154 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
155 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
157 ///! Returns true if parametric updater need to execute feature on recomputartion
158 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
159 bool executeFeatures() {return myExecuteFeatures;}
161 //! Registers the name of the shape for the topological naming needs
162 void addNamingName(const TDF_Label theLabel, std::string theName);
163 //! Returns the label, keeper of the name for the topological naming needs
164 TDF_Label findNamingName(std::string theName);
165 //! Returns the result by name of the result (names of results must be unique, used for naming
166 //! selection by name.
167 ResultPtr findByName(const std::string theName);
171 //! Returns (creates if needed) the features label
172 TDF_Label featuresLabel() const;
174 //! Initializes feature with a unique name in this group (unique name is generated as
175 //! feature type + "_" + index
176 void setUniqueName(FeaturePtr theFeature);
178 //! Synchronizes myFeatures list with the updated document
179 //! \param theMarkUpdated causes the "update" event for all features
180 //! \param theUpdateReferences causes the update of back-references
181 //! \param theFlush makes flush all events in the end of all modifications of this method
182 void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences,
183 const bool theFlush);
184 //! Synchronizes the BackReferences list in Data of Features and Results
185 void synchronizeBackRefs();
187 //! Creates new document with binary file format
188 Model_Document(const std::string theID, const std::string theKind);
190 //! Returns the internal OCCT document of this interface
191 Handle_TDocStd_Document document()
196 //! performs compactification of all nested operations into one
197 //! \returns true if resulting transaction is not empty and can be undoed
198 void compactNested();
200 //! Initializes the data fields of the feature
201 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
203 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
204 MODEL_EXPORT virtual void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
205 std::shared_ptr<ModelAPI_Result> theResult,
206 const int theResultIndex = 0);
208 //! returns the label of result by index; creates this label if it was not created before
209 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
211 //! Updates the results list of the feature basing on the current data tree
212 void updateResults(FeaturePtr theFeature);
214 //! Returns all sub documents
215 const std::set<std::string> subDocuments(const bool theActivatedOnly) const;
217 //! The implementation of undo: with or without recoursive calls in the sub-documents
218 void undoInternal(const bool theWithSubs, const bool theSynchronize);
220 //! Stores the Id of the current operation (normally is called for the root document)
221 void operationId(const std::string& theId);
223 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
224 std::list<std::string> undoList() const;
226 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
227 std::list<std::string> redoList() const;
229 /// Internally makes document know that feature was removed or added in history after creation
230 MODEL_EXPORT virtual void addToHistory(const std::shared_ptr<ModelAPI_Object> theObject);
232 /// Returns true if the document is root module document
235 friend class Model_Application;
236 friend class Model_Session;
237 friend class Model_Update;
238 friend class Model_AttributeReference;
239 friend class DFBrowser;
242 std::string myID; ///< identifier of the document in the application
243 std::string myKind; ///< kind of the document in the application
244 Handle_TDocStd_Document myDoc; ///< OCAF document
246 /// counter value of transaction on the last "save" call, used for "IsModified" method
247 int myTransactionSave;
248 /// number of nested transactions performed (list becasue may be nested inside of nested)
249 /// the list is empty if not nested transaction is performed
250 std::list<int> myNestedNum;
252 /// Information related to the every user-transaction
254 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
255 std::string myId; ///< user-identifier string of transaction
256 /// default constructor with default Id
257 Transaction(): myOCAFNum(0), myId("") {}
260 /// transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
261 /// in myDocument connected to this operation (may be zero for empty transaction)
262 std::list<Transaction> myTransactions;
263 /// list of info about transactions undone (first is oldest undone)
264 std::list<Transaction> myRedos;
265 /// All features managed by this document (not only in history of OB)
266 /// For optimization mapped by labels
267 NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
268 /// Optimization for finding the shape-label by topological naming names
269 std::map<std::string, TDF_Label> myNamingNames;
270 /// If it is true, features are not executed on update (on abort, undo, redo)
271 bool myExecuteFeatures;