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>
20 class Handle_Model_Document;
23 /**\class Model_Document
25 * \brief Document for internal data structure of any object storage.
26 * Document contains all data that must be stored/retrived in the file.
27 * Also it provides acces to this data: open/save, transactions management etc.
29 class Model_Document : public ModelAPI_Document
32 //! Returns the kind of the document: "PartSet", "Part", or something else.
33 //! This kind is used for feature buttons enable/disable depending on active document
34 //! (it uses workbench "document" identifier in XML configuration file for this)
35 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
37 //! Loads the OCAF document from the file.
38 //! \param theFileName full name of the file to load
39 //! \param theThis the common shared pointer to the document to manage with it later
40 //! \returns true if file was loaded successfully
41 MODEL_EXPORT virtual bool load(const char* theFileName, DocumentPtr theThis);
43 //! Saves the OCAF document to the file.
44 //! \param theFileName full name of the file to store
45 //! \param theResults the result full file names that were stored by "save"
46 //! \returns true if file was stored successfully
47 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
49 //! Removes document data
50 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
51 MODEL_EXPORT virtual void close(const bool theForever = false);
53 //! Starts a new operation (opens a tansaction)
54 MODEL_EXPORT virtual void startOperation();
55 //! Finishes the previously started operation (closes the transaction)
56 //! \returns true if transaction in this document is not empty and really was performed
57 MODEL_EXPORT virtual bool finishOperation();
58 //! Aborts the operation
59 MODEL_EXPORT virtual void abortOperation();
60 //! Returns true if operation has been started, but not yet finished or aborted
61 MODEL_EXPORT virtual bool isOperation() const;
62 //! Returns true if document was modified (since creation/opening)
63 MODEL_EXPORT virtual bool isModified();
65 //! Returns True if there are available Undos
66 MODEL_EXPORT virtual bool canUndo();
67 //! Undoes last operation
68 MODEL_EXPORT virtual void undo();
69 //! Returns True if there are available Redos
70 MODEL_EXPORT virtual bool canRedo();
71 //! Redoes last operation
72 MODEL_EXPORT virtual void redo();
74 //! Adds to the document the new feature of the given feature id
75 //! \param theID creates feature and puts it in the document
76 //! \param theMakeCurrent to make current this new feature in this document
77 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true);
79 //! Return a list of features, which refers to the feature
80 //! \param theFeature a feature
81 //! \param theRefs a list of reference features
82 //! \param isSendError a flag whether the error message should be send
83 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
84 std::set<FeaturePtr>& theRefs,
85 const bool isSendError = true);
87 //! Removes the feature from the document (with result)
88 //! \param theFeature a removed feature
89 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
91 //! Moves the feature to make it after the given one in the history.
92 MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
94 //! Returns the first found object in the group by the object name
95 //! \param theGroupID group that contains an object
96 //! \param theName name of the object to search
97 //! \returns null if such object is not found
98 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
99 const std::string& theGroupID, const std::string& theName);
101 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
102 //! \param theObject object of this document
103 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
104 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject);
106 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
107 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
109 //! Internal sub-document by ID
110 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(std::string theDocID);
112 ///! Returns the id of hte document
113 MODEL_EXPORT virtual const std::string& id() const
118 //! Returns the feature in the group by the index (started from zero)
119 //! \param theGroupID group that contains a feature
120 //! \param theIndex zero-based index of feature in the group
121 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex);
123 //! Returns the number of features in the group
124 MODEL_EXPORT virtual int size(const std::string& theGroupID);
126 //! Returns the feature that is currently edited in this document, normally
127 //! this is the latest created feature
128 //! \param theVisible use visible features only: flag is true for Object Browser functionality
129 //! \returns null if next created feature must be the first
130 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
132 //! Sets the current feature: all features below will be disabled, new features
133 //! will be appended after this one.
134 //! \param theCurrent the selected feature as current: blow it everythin become disabled
135 //! \param theVisible use visible features only: flag is true for Object Browser functionality
136 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
137 const bool theVisible);
139 //! Makes the current feature one feature upper
140 MODEL_EXPORT virtual void setCurrentFeatureUp();
142 //! Returns the number of all features: in the history or not
143 MODEL_EXPORT virtual int numInternalFeatures();
144 //! Returns the feature by zero-based index: features in the history or not
145 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
147 /// Creates a construction cresults
148 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
149 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
150 /// Creates a body results
151 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
152 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
153 /// Creates a part results
154 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
155 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
156 /// Creates a group results
157 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
158 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
160 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
161 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
163 //! Returns a feature by result (owner of result)
164 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
165 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
167 ///! Returns true if parametric updater need to execute feature on recomputartion
168 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
169 bool& executeFeatures() {return myExecuteFeatures;}
171 //! Registers the name of the shape for the topological naming needs
172 void addNamingName(const TDF_Label theLabel, std::string theName);
173 //! Returns the label, keeper of the name for the topological naming needs
174 TDF_Label findNamingName(std::string theName);
175 //! Returns the result by name of the result (names of results must be unique, used for naming
176 //! selection by name.
177 ResultPtr findByName(const std::string theName);
179 ///! Returns all features of the document including the hidden features which are not in
180 ///! history. Not very fast method, for calling once, not in big cycles.
181 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
183 /// Returns the global identifier of the current transaction (needed for the update algo)
184 MODEL_EXPORT virtual int transactionID();
185 /// Increases the transaction ID
186 MODEL_EXPORT virtual void incrementTransactionID();
187 /// Decreases the transaction ID
188 MODEL_EXPORT virtual void decrementTransactionID();
190 /// Returns true if document is opened and valid
191 MODEL_EXPORT virtual bool isOpened();
194 //! Returns (creates if needed) the general label
195 TDF_Label generalLabel() const;
197 //! Creates new document with binary file format
198 Model_Document(const std::string theID, const std::string theKind);
200 //! Returns the internal OCCT document of this interface
201 Handle_TDocStd_Document document()
206 //! performs compactification of all nested operations into one
207 //! \returns true if resulting transaction is not empty and can be undoed
208 void compactNested();
210 //! Returns all sub documents
211 const std::set<std::string> subDocuments(const bool theActivatedOnly) const;
213 //! The implementation of undo: with or without recoursive calls in the sub-documents
214 void undoInternal(const bool theWithSubs, const bool theSynchronize);
216 //! Stores the Id of the current operation (normally is called for the root document)
217 void operationId(const std::string& theId);
219 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
220 std::list<std::string> undoList() const;
222 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
223 std::list<std::string> redoList() const;
225 //! Internally makes document know that feature was removed or added in history after creation
226 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
227 //! Internally makes document know that feature was removed or added in history after creation
228 virtual void updateHistory(const std::string theGroup);
230 //! Returns true if the document is root module document
233 //! Sets shared pointer to this
234 void setThis(DocumentPtr theDoc);
236 //! Returns the objects manager
237 Model_Objects* objects() {return myObjs;}
239 ///! Informs the document that it becomes active and some actions must be performed
240 virtual void setActive(const bool theFlag);
241 //! Returns true if this document is currently active
242 virtual bool isActive() const;
244 friend class Model_Application;
245 friend class Model_Session;
246 friend class Model_Update;
247 friend class Model_AttributeReference;
248 friend class Model_AttributeRefAttr;
249 friend class Model_AttributeRefList;
250 friend class Model_ResultPart;
251 friend class DFBrowser;
254 std::string myID; ///< identifier of the document in the application
255 std::string myKind; ///< kind of the document in the application
256 Handle_TDocStd_Document myDoc; ///< OCAF document
258 Model_Objects *myObjs; ///< data manager of this document
260 //! counter value of transaction on the last "save" call, used for "IsModified" method
261 int myTransactionSave;
262 //! number of nested transactions performed (list becasue may be nested inside of nested)
263 //! the list is empty if not nested transaction is performed
264 std::list<int> myNestedNum;
266 //! Information related to the every user-transaction
268 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
269 std::string myId; ///< user-identifier string of transaction
270 //! default constructor with default Id
271 Transaction(): myOCAFNum(0), myId("") {}
274 //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
275 //! in myDocument connected to this operation (may be zero for empty transaction)
276 std::list<Transaction> myTransactions;
277 //! list of info about transactions undone (first is oldest undone)
278 std::list<Transaction> myRedos;
280 //! Optimization for finding the shape-label by topological naming names
281 std::map<std::string, TDF_Label> myNamingNames;
282 //! If it is true, features are not executed on update (on abort, undo, redo)
283 bool myExecuteFeatures;
285 bool myIsActive; ///< flag that stores the active/not active state