1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #ifndef Model_Document_H_
21 #define Model_Document_H_
24 #include <ModelAPI_Document.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Result.h>
27 #include <ModelAPI_ResultParameter.h>
29 #include <TDocStd_Document.hxx>
33 class Handle_Model_Document;
35 class ModelAPI_AttributeSelectionList;
37 /**\class Model_Document
39 * \brief Document for internal data structure of any object storage.
40 * Document contains all data that must be stored/retrived in the file.
41 * Also it provides acces to this data: open/save, transactions management etc.
43 class Model_Document : public ModelAPI_Document
46 //! Returns the kind of the document: "PartSet", "Part", or something else.
47 //! This kind is used for feature buttons enable/disable depending on active document
48 //! (it uses workbench "document" identifier in XML configuration file for this)
49 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
51 //! Loads the OCAF document from the file.
52 //! \param theDirName directory of the loaded file
53 //! \param theFileName a name of the file to load
54 //! \param theThis the common shared pointer to the document to manage with it later
55 //! \returns true if file was loaded successfully
56 MODEL_EXPORT virtual bool load(
57 const char* theDirName, const char* theFileName, DocumentPtr theThis);
59 //! Saves the OCAF document to the file.
60 //! \param theDirName directory where the document will be saved
61 //! \param theFileName a name of the document file to store
62 //! \param theResults the result full file names that were stored by "save"
63 //! \returns true if file was stored successfully
64 MODEL_EXPORT virtual bool save(
65 const char* theDirName, const char* theFileName, std::list<std::string>& theResults);
67 //! Removes document data
68 //! \param theForever if it is false, document is just hiden
69 //! (to keep possibility make it back on Undo/Redo)
70 MODEL_EXPORT virtual void close(const bool theForever = false);
72 //! Starts a new operation (opens a tansaction)
73 MODEL_EXPORT virtual void startOperation();
74 //! Finishes the previously started operation (closes the transaction)
75 //! \returns true if transaction in this document is not empty and really was performed
76 MODEL_EXPORT virtual bool finishOperation();
77 //! Aborts the operation
78 MODEL_EXPORT virtual void abortOperation();
79 //! Returns true if operation has been started, but not yet finished or aborted
80 MODEL_EXPORT virtual bool isOperation() const;
81 //! Returns true if document was modified (since creation/opening)
82 MODEL_EXPORT virtual bool isModified();
84 //! Returns True if there are available Undos
85 MODEL_EXPORT virtual bool canUndo();
86 //! Undoes last operation
87 MODEL_EXPORT virtual void undo();
88 //! Returns True if there are available Redos
89 MODEL_EXPORT virtual bool canRedo();
90 //! Redoes last operation
91 MODEL_EXPORT virtual void redo();
93 //! Adds to the document the new feature of the given feature id
94 //! \param theID creates feature and puts it in the document
95 //! \param theMakeCurrent to make current this new feature in this document
96 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true);
98 //! Return a list of features, which refers to the feature
99 //! \param theFeature a feature
100 //! \param theRefs a list of reference features
101 //! \param isSendError a flag whether the error message should be send
102 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
103 std::set<FeaturePtr>& theRefs,
104 const bool isSendError = true);
106 //! Removes the feature from the document (with result)
107 //! It is necessary to flush REDISPLAY signal manually after this method because
108 //! the method sends it, but for the performance purpose does not flush it
109 //! \param theFeature a removed feature
110 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
112 //! Moves the feature to make it after the given one in the history.
113 MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
115 //! Returns the first found object in the group by the object name
116 //! \param theGroupID group that contains an object
117 //! \param theName name of the object to search
118 //! \returns null if such object is not found
119 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
120 const std::string& theGroupID, const std::string& theName);
122 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
123 //! \param theObject object of this document
124 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
125 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject);
127 //! Internal sub-document by ID
128 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(int theDocID);
130 ///! Returns the id of the document
131 MODEL_EXPORT virtual const int id() const
136 //! Returns the feature in the group by the index (started from zero)
137 //! \param theGroupID group that contains a feature
138 //! \param theIndex zero-based index of feature in the group
139 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex);
141 //! Returns the number of features in the group
142 MODEL_EXPORT virtual int size(const std::string& theGroupID);
144 //! Returns the feature that is currently edited in this document, normally
145 //! this is the latest created feature
146 //! \param theVisible use visible features only: flag is true for Object Browser functionality
147 //! \returns null if next created feature must be the first
148 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
150 //! Sets the current feature: all features below will be disabled, new features
151 //! will be appended after this one.
152 //! \param theCurrent the selected feature as current: blow it everythin become disabled
153 //! \param theVisible use visible features only: flag is true for Object Browser functionality
154 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
155 const bool theVisible);
157 //! Makes the current feature one feature upper
158 MODEL_EXPORT virtual void setCurrentFeatureUp();
160 //! Returns the number of all features: in the history or not
161 MODEL_EXPORT virtual int numInternalFeatures();
162 //! Returns the feature by zero-based index: features in the history or not
163 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
164 //! Performs synchronization of transactions with the module document:
165 //! If some document is not active (by undo of activation) but in memory,
166 //! on activation the transactions must be synchronised because all redos performed
167 //! wihtout this participation
168 MODEL_EXPORT virtual void synchronizeTransactions();
170 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
171 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
174 /// Creates a construction cresults
175 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
176 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
177 /// Creates a body results
178 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
179 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
180 /// Creates a part results
181 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
182 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
183 //! Copies a part result, keeping the reference to origin
184 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
185 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
186 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
187 /// Creates a group result
188 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
189 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
190 /// Creates a field result
191 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultField> createField(
192 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
193 /// Creates a parameter result
194 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
195 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
197 //! Returns a feature by result (owner of result)
198 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
199 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
201 ///! Returns true if parametric updater need to execute feature on recomputartion
202 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
203 bool& executeFeatures() {return myExecuteFeatures;}
205 //! Registers the name of the shape for the topological naming needs
206 void addNamingName(const TDF_Label theLabel, std::string theName);
207 //! Updates the name of some object
208 void changeNamingName(std::string theOldName, const std::string theNewName);
209 //! Returns the label, keeper of the name for the topological naming needs
210 TDF_Label findNamingName(std::string theName);
211 //! Returns the result by name of the result (names of results must be unique, used for naming
212 //! selection by name.
213 ResultPtr findByName(const std::string theName);
215 ///! Returns all features of the document including the hidden features which are not in
216 ///! history. Not very fast method, for calling once, not in big cycles.
217 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
219 /// Returns the global identifier of the current transaction (needed for the update algo)
220 MODEL_EXPORT virtual int transactionID();
221 /// Increases the transaction ID
222 MODEL_EXPORT virtual void incrementTransactionID();
223 /// Decreases the transaction ID
224 MODEL_EXPORT virtual void decrementTransactionID();
226 /// Returns true if document is opened and valid
227 MODEL_EXPORT virtual bool isOpened();
229 /// Returns the last feature in the document (even not visible or disabled)
230 /// \returns null if there is no features
231 FeaturePtr lastFeature();
233 /// Returns the feature that produced the given face of the given result.
234 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
235 std::shared_ptr<ModelAPI_Result> theResult,
236 const std::shared_ptr<GeomAPI_Shape>& theShape);
238 /// Returns true if theLater is in history of features creation later than theCurrent
239 MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
241 /// Just removes all features without touching the document data (to be able undo)
242 MODEL_EXPORT virtual void eraseAllFeatures();
246 //! Returns (creates if needed) the general label
247 TDF_Label generalLabel() const;
249 //! Creates new document with binary file format
250 Model_Document(const int theID, const std::string theKind);
252 //! Returns the internal OCCT document of this interface
253 Handle_TDocStd_Document document()
258 //! performs compactification of all nested operations into one
259 //! \returns true if resulting transaction is not empty and can be undoed
260 void compactNested();
262 //! Returns all loaded sub documents
263 const std::set<int> subDocuments() const;
265 //! The implementation of undo: with or without recoursive calls in the sub-documents
266 void undoInternal(const bool theWithSubs, const bool theSynchronize);
268 //! Stores the Id of the current operation (normally is called for the root document)
269 void operationId(const std::string& theId);
271 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
272 std::list<std::string> undoList() const;
274 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
275 std::list<std::string> redoList() const;
277 //! Internally makes document know that feature was removed or added in history after creation
278 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
279 //! Internally makes document know that feature was removed or added in history after creation
280 virtual void updateHistory(const std::string theGroup);
282 //! Returns true if the document is root module document
285 //! Sets shared pointer to this
286 void setThis(DocumentPtr theDoc);
288 //! Returns the objects manager
289 Model_Objects* objects() {return myObjs;}
291 ///! Informs the document that it becomes active and some actions must be performed
292 virtual void setActive(const bool theFlag);
293 //! Returns true if this document is currently active
294 virtual bool isActive() const;
296 //! Returns the selection attribute that is used
297 //! for calculation of selection externally from the document
298 std::shared_ptr<ModelAPI_AttributeSelectionList> selectionInPartFeature();
300 /// Stores in the document boolean flags: states of the nodes in the object browser.
301 /// Normally is called outside of the transaction, just before "save".
302 virtual void storeNodesState(const std::list<bool>& theStates);
304 /// Returns the stored nodes states. Normally it is calles just after "open".
305 /// Appends the values to theStates list.
306 virtual void restoreNodesState(std::list<bool>& theStates) const;
308 /// Label that constains structures for selection of constructions of another document
309 TDF_Label extConstructionsLabel() const;
311 friend class Model_Application;
312 friend class Model_Session;
313 friend class Model_Update;
314 friend class Model_AttributeReference;
315 friend class Model_AttributeRefAttr;
316 friend class Model_AttributeRefList;
317 friend class Model_AttributeRefAttrList;
318 friend class Model_AttributeSelection;
319 friend class Model_ResultPart;
320 friend class Model_ResultCompSolid;
321 friend class Model_ResultConstruction;
322 friend class Model_SelectionNaming;
323 friend class DFBrowser;
326 int myID; ///< identifier of the document in the application
327 std::string myKind; ///< kind of the document in the application
328 Handle_TDocStd_Document myDoc; ///< OCAF document
330 Model_Objects *myObjs; ///< data manager of this document
332 //! counter value of transaction on the last "save" call, used for "IsModified" method
333 int myTransactionSave;
334 //! number of nested transactions performed (list becasue may be nested inside of nested)
335 //! the list is empty if not nested transaction is performed
336 std::list<int> myNestedNum;
338 //! Information related to the every user-transaction
340 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
341 std::string myId; ///< user-identifier string of transaction
342 //! default constructor with default Id
343 Transaction(): myOCAFNum(0), myId("") {}
346 //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
347 //! in myDocument connected to this operation (may be zero for empty transaction)
348 std::list<Transaction> myTransactions;
349 //! list of info about transactions undone (first is oldest undone)
350 std::list<Transaction> myRedos;
352 //! Optimization for finding the shape-label by topological naming names
353 std::map<std::string, TDF_Label> myNamingNames;
354 //! If it is true, features are not executed on update (on abort, undo, redo)
355 bool myExecuteFeatures;
357 bool myIsActive; ///< flag that stores the active/not active state
359 //! The selection feature, if needed
360 FeaturePtr mySelectionFeature;