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 //! \returns true if file was loaded successfully
40 MODEL_EXPORT virtual bool load(const char* theFileName);
42 //! Saves the OCAF document to the file.
43 //! \param theFileName full name of the file to store
44 //! \param theResults the result full file names that were stored by "save"
45 //! \returns true if file was stored successfully
46 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
48 //! Removes document data
49 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
50 MODEL_EXPORT virtual void close(const bool theForever = false);
52 //! Starts a new operation (opens a tansaction)
53 MODEL_EXPORT virtual void startOperation();
54 //! Finishes the previously started operation (closes the transaction)
55 //! \returns true if transaction in this document is not empty and really was performed
56 MODEL_EXPORT virtual bool finishOperation();
57 //! Aborts the operation
58 MODEL_EXPORT virtual void abortOperation();
59 //! Returns true if operation has been started, but not yet finished or aborted
60 MODEL_EXPORT virtual bool isOperation() const;
61 //! Returns true if document was modified (since creation/opening)
62 MODEL_EXPORT virtual bool isModified();
64 //! Returns True if there are available Undos
65 MODEL_EXPORT virtual bool canUndo();
66 //! Undoes last operation
67 MODEL_EXPORT virtual void undo();
68 //! Returns True if there are available Redos
69 MODEL_EXPORT virtual bool canRedo();
70 //! Redoes last operation
71 MODEL_EXPORT virtual void redo();
73 //! Adds to the document the new feature of the given feature id
74 //! \param theID creates feature and puts it in the document
75 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
77 //! Return a list of features, which refers to the feature
78 //! \param theFeature a feature
79 //! \param theRefs a list of reference features
80 //! \param isSendError a flag whether the error message should be send
81 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
82 std::set<FeaturePtr>& theRefs,
83 const bool isSendError = true);
85 //! Removes the feature from the document (with result)
86 //! \param theFeature a removed feature
87 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
89 //! Returns the first found object in the group by the object name
90 //! \param theGroupID group that contains an object
91 //! \param theName name of the object to search
92 //! \returns null if such object is not found
93 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
94 const std::string& theGroupID, const std::string& theName);
96 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
97 //! \param theObject object of this document
98 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
99 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject);
101 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
102 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
104 //! Internal sub-document by ID
105 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(std::string theDocID);
107 ///! Returns the id of hte document
108 MODEL_EXPORT virtual const std::string& id() const
113 //! Returns the feature in the group by the index (started from zero)
114 //! \param theGroupID group that contains a feature
115 //! \param theIndex zero-based index of feature in the group
116 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex);
118 //! Returns the number of features in the group
119 MODEL_EXPORT virtual int size(const std::string& theGroupID);
121 //! Returns the feature that is currently edited in this document, normally
122 //! this is the latest created feature
123 //! \param theVisible use visible features only: flag is true for Object Browser functionality
124 //! \returns null if next created feature must be the first
125 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
127 //! Sets the current feature: all features below will be disabled, new features
128 //! will be appended after this one.
129 //! \param theCurrent the selected feature as current: blow it everythin become disabled
130 //! \param theVisible use visible features only: flag is true for Object Browser functionality
131 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
132 const bool theVisible);
134 /// Creates a construction cresults
135 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
136 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
137 /// Creates a body results
138 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
139 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
140 /// Creates a part results
141 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
142 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
143 /// Creates a group results
144 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
145 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
147 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
148 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
150 //! Returns a feature by result (owner of result)
151 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
152 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
154 ///! Returns true if parametric updater need to execute feature on recomputartion
155 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
156 bool& executeFeatures() {return myExecuteFeatures;}
158 //! Registers the name of the shape for the topological naming needs
159 void addNamingName(const TDF_Label theLabel, std::string theName);
160 //! Returns the label, keeper of the name for the topological naming needs
161 TDF_Label findNamingName(std::string theName);
162 //! Returns the result by name of the result (names of results must be unique, used for naming
163 //! selection by name.
164 ResultPtr findByName(const std::string theName);
167 //! Returns (creates if needed) the general label
168 TDF_Label generalLabel() const;
170 //! Creates new document with binary file format
171 Model_Document(const std::string theID, const std::string theKind);
173 //! Returns the internal OCCT document of this interface
174 Handle_TDocStd_Document document()
179 //! performs compactification of all nested operations into one
180 //! \returns true if resulting transaction is not empty and can be undoed
181 void compactNested();
183 //! Returns all sub documents
184 const std::set<std::string> subDocuments(const bool theActivatedOnly) const;
186 //! The implementation of undo: with or without recoursive calls in the sub-documents
187 void undoInternal(const bool theWithSubs, const bool theSynchronize);
189 //! Stores the Id of the current operation (normally is called for the root document)
190 void operationId(const std::string& theId);
192 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
193 std::list<std::string> undoList() const;
195 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
196 std::list<std::string> redoList() const;
198 /// Internally makes document know that feature was removed or added in history after creation
199 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
200 /// Internally makes document know that feature was removed or added in history after creation
201 virtual void updateHistory(const std::string theGroup);
203 /// Returns true if the document is root module document
206 /// Sets shared pointer to this
207 void setThis(DocumentPtr theDoc);
209 /// Returns the objects manager
210 Model_Objects* objects() {return myObjs;}
212 friend class Model_Application;
213 friend class Model_Session;
214 friend class Model_Update;
215 friend class Model_AttributeReference;
216 friend class Model_AttributeRefAttr;
217 friend class Model_AttributeRefList;
218 friend class DFBrowser;
221 std::string myID; ///< identifier of the document in the application
222 std::string myKind; ///< kind of the document in the application
223 Handle_TDocStd_Document myDoc; ///< OCAF document
225 Model_Objects *myObjs; ///< data manager of this document
227 /// counter value of transaction on the last "save" call, used for "IsModified" method
228 int myTransactionSave;
229 /// number of nested transactions performed (list becasue may be nested inside of nested)
230 /// the list is empty if not nested transaction is performed
231 std::list<int> myNestedNum;
233 /// Information related to the every user-transaction
235 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
236 std::string myId; ///< user-identifier string of transaction
237 /// default constructor with default Id
238 Transaction(): myOCAFNum(0), myId("") {}
241 /// transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
242 /// in myDocument connected to this operation (may be zero for empty transaction)
243 std::list<Transaction> myTransactions;
244 /// list of info about transactions undone (first is oldest undone)
245 std::list<Transaction> myRedos;
247 /// Optimization for finding the shape-label by topological naming names
248 std::map<std::string, TDF_Label> myNamingNames;
249 /// If it is true, features are not executed on update (on abort, undo, redo)
250 bool myExecuteFeatures;