1 // Copyright (C) 2014-2020 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
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/retrieved in the file.
41 * Also it provides access 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 //! Loads the OCAF document from the file into the current document.
60 //! All the features are added after the active feature.
61 //! \param theFileName name of the file to import
62 //! \param theImported list of features imported from the file
63 //! \param theCheckOnly verify the document does not contain unappropriate features
64 //! (useful for import to PartSet), but do not import it
65 //! \returns true if file was loaded successfully
66 MODEL_EXPORT virtual bool importPart(const char* theFileName,
67 std::list<std::shared_ptr<ModelAPI_Feature> >& theImported,
68 bool theCheckOnly = false);
70 //! Saves the OCAF document to the file.
71 //! \param theDirName directory where the document will be saved
72 //! \param theFileName a name of the document file to store
73 //! \param theResults the result full file names that were stored by "save"
74 //! \returns true if file was stored successfully
75 MODEL_EXPORT virtual bool save(
76 const char* theDirName, const char* theFileName, std::list<std::string>& theResults);
78 //! Export the list of features to the file
79 //! \param theFilename path to save the file
80 //! \param theExportFeatures list of features to export
81 MODEL_EXPORT virtual bool save(const char* theFilename,
82 const std::list<std::shared_ptr<ModelAPI_Feature> >& theExportFeatures) const;
84 //! Removes document data
85 //! \param theForever if it is false, document is just hidden
86 //! (to keep possibility make it back on Undo/Redo)
87 MODEL_EXPORT virtual void close(const bool theForever = false);
89 //! Starts a new operation (opens a transaction)
90 MODEL_EXPORT virtual void startOperation();
91 //! Finishes the previously started operation (closes the transaction)
92 //! \returns true if transaction in this document is not empty and really was performed
93 MODEL_EXPORT virtual bool finishOperation();
94 //! Aborts the operation
95 MODEL_EXPORT virtual void abortOperation();
96 //! Returns true if operation has been started, but not yet finished or aborted
97 MODEL_EXPORT virtual bool isOperation() const;
98 //! Returns true if document was modified (since creation/opening)
99 MODEL_EXPORT virtual bool isModified();
101 //! Returns True if there are available Undo-s
102 MODEL_EXPORT virtual bool canUndo();
103 //! Undoes last operation
104 MODEL_EXPORT virtual void undo();
105 //! Returns True if there are available Redo-s
106 MODEL_EXPORT virtual bool canRedo();
107 //! Redoes last operation
108 MODEL_EXPORT virtual void redo();
110 //! Adds to the document the new feature of the given feature id
111 //! \param theID creates feature and puts it in the document
112 //! \param theMakeCurrent to make current this new feature in this document
113 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true);
115 //! Return a list of features, which refers to the feature
116 //! \param theFeature a feature
117 //! \param theRefs a list of reference features
118 //! \param isSendError a flag whether the error message should be send
119 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
120 std::set<FeaturePtr>& theRefs,
121 const bool isSendError = true);
123 //! Removes the feature from the document (with result)
124 //! It is necessary to flush REDISPLAY signal manually after this method because
125 //! the method sends it, but for the performance purpose does not flush it
126 //! \param theFeature a removed feature
127 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
129 //! Moves the feature to make it after the given one in the history.
130 MODEL_EXPORT virtual void moveFeature(
131 FeaturePtr theMoved, FeaturePtr theAfterThis, const bool theSplit = false);
133 //! Returns the first found object in the group by the object name
134 //! \param theGroupID group that contains an object
135 //! \param theName name of the object to search
136 //! \returns null if such object is not found
137 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
138 const std::string& theGroupID, const std::wstring& theName);
140 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
141 //! \param theObject object of this document
142 //! \param theAllowFolder take into account grouping feature by folders
143 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
144 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject,
145 const bool theAllowFolder = false);
147 //! Internal sub-document by ID
148 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(int theDocID);
150 ///! Returns the id of the document
151 MODEL_EXPORT virtual const int id() const
156 //! Returns the feature in the group by the index (started from zero)
157 //! \param theGroupID group that contains a feature
158 //! \param theIndex zero-based index of feature in the group
159 //! \param theAllowFolder take into account grouping feature by folders
160 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID,
162 const bool theAllowFolder = false);
164 //! Returns the number of features in the group
165 //! \param theGroupID group of objects
166 //! \param theAllowFolder take into account grouping feature by folders
167 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theAllowFolder = false);
169 //! Returns the parent object of this child. This may be result or feature, parent of a
170 //! top result. Fast method, that uses internal data structure specifics.
171 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> parent(
172 const std::shared_ptr<ModelAPI_Object> theChild);
174 //! Returns the feature that is currently edited in this document, normally
175 //! this is the latest created feature
176 //! \param theVisible use visible features only: flag is true for Object Browser functionality
177 //! \returns null if next created feature must be the first
178 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
180 //! Sets the current feature: all features below will be disabled, new features
181 //! will be appended after this one.
182 //! \param theCurrent the selected feature as current: below it everything becomes disabled
183 //! \param theVisible use visible features only: flag is true for Object Browser functionality
184 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
185 const bool theVisible);
187 //! Makes the current feature one feature upper
188 MODEL_EXPORT virtual void setCurrentFeatureUp();
190 //! Returns the number of all features: in the history or not
191 MODEL_EXPORT virtual int numInternalFeatures();
192 //! Returns the feature by zero-based index: features in the history or not
193 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
194 //! Performs synchronization of transactions with the module document:
195 //! If some document is not active (by undo of activation) but in memory,
196 //! on activation the transactions must be synchronized because all redo-s performed
197 //! without this participation
198 MODEL_EXPORT virtual void synchronizeTransactions();
200 /// Creates construction results
201 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
202 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
203 /// Creates a body results
204 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
205 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
206 /// Creates a part results
207 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
208 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
209 //! Copies a part result, keeping the reference to origin
210 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
211 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
212 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
213 /// Creates a group result
214 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
215 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
216 /// Creates a field result
217 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultField> createField(
218 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
219 /// Creates a parameter result
220 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
221 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
223 //! Returns a feature by result (owner of result)
224 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
225 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
227 //! Creates a folder (group of the features in the object browser)
228 //! \param theAddBefore a feature, the folder is added before
229 //! (if empty, the folder is added after the last feature)
230 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> addFolder(
231 std::shared_ptr<ModelAPI_Feature> theAddBefore = std::shared_ptr<ModelAPI_Feature>());
232 //! Removes the folder from the document (all features in the folder will be kept).
233 MODEL_EXPORT virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
234 //! Search a folder above the list of features applicable to store them
235 //! (it means the list of features stored in the folder should be consequential)
236 //! \return Empty pointer if there is no applicable folder
237 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findFolderAbove(
238 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures);
239 //! Search a folder below the list of features applicable to store them
240 //! (it means the list of features stored in the folder should be consequential)
241 //! \return Empty pointer if there is no applicable folder
242 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findFolderBelow(
243 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures);
244 //! Search a folder containing the given feature.
245 //! Additionally calculates a zero-based index of the feature in this folder.
246 //! \param theFeature feature to search
247 //! \param theIndexInFolder zero-based index in the folder or -1 if the feature is top-level.
248 //! \return the folder containing the feature or empty pointer if the feature is top-level.
249 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findContainingFolder(
250 const std::shared_ptr<ModelAPI_Feature>& theFeature,
251 int& theIndexInFolder);
252 //! Add a list of features to the folder. The correctness of the adding is not performed
253 //! (such checks have been done in corresponding find.. method).
254 //! \return \c true if the movement is successful
255 MODEL_EXPORT virtual bool moveToFolder(
256 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
257 const std::shared_ptr<ModelAPI_Folder>& theFolder);
258 //! Remove features from the folder
259 //! \param theFeatures list of features to be removed
260 //! \param theBefore extract features before the folder (this parameter is applicable only
261 //! when all features in the folder are taking out,
262 //! in other cases the direction is taken automatically)
263 //! \return \c true if the features have been moved out
264 MODEL_EXPORT virtual bool removeFromFolder(
265 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
266 const bool theBefore = true);
268 ///! Returns true if parametric updater need to execute feature on recomputation
269 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
270 bool executeFeatures() {return myExecuteFeatures;}
272 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
273 void setExecuteFeatures(const bool theFlag);
275 //! Registers the name of the shape for the topological naming needs
276 void addNamingName(const TDF_Label theLabel, std::wstring theName);
277 //! Updates the name of some object
278 void changeNamingName(std::wstring theOldName, const std::wstring theNewName,
279 const TDF_Label& theLabel);
280 //! Returns the label, keeper of the name for the topological naming needs
281 TDF_Label findNamingName(std::wstring theName, ResultPtr theContext);
282 //! Returns the number of the name in the history relatively to the given object (by label).
283 //! Start from 1 (this object).
284 int numberOfNameInHistory(const ObjectPtr& theNameObject, const TDF_Label& theStartFrom);
285 //! Returns the result by name of the result (names of results must be unique, used for naming
286 //! selection by name.
287 ResultPtr findByName(std::wstring& theName,
288 std::wstring& theSubShapeName,
289 bool& theUniqueContext);
291 ///! Returns all features of the document including the hidden features which are not in
292 ///! history. Not very fast method, for calling once, not in big cycles.
293 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
295 //! Returns all objects of the document including the hidden features which are not in
296 //! history. Not very fast method, for calling once, not in big cycles.
297 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
299 /// Returns the global identifier of the current transaction (needed for the update algo)
300 MODEL_EXPORT virtual int transactionID();
301 /// Increases the transaction ID
302 MODEL_EXPORT virtual void incrementTransactionID();
304 /// Returns true if document is opened and valid
305 MODEL_EXPORT virtual bool isOpened();
307 /// Returns the last feature in the document (even not visible or disabled)
308 /// \returns null if there is no features
309 FeaturePtr lastFeature();
311 /// Returns the feature that produced the given face of the given result.
312 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
313 std::shared_ptr<ModelAPI_Result> theResult,
314 const std::shared_ptr<GeomAPI_Shape>& theShape);
316 /// Returns true if theLater is in history of features creation later than theCurrent
317 MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
319 /// Just removes all features without touching the document data (to be able undo)
320 MODEL_EXPORT virtual void eraseAllFeatures();
322 /// Returns the next (from the history point of view) feature, any: invisible or disabled
323 /// \param theCurrent previous to the resulting feature
324 /// \param theReverse if it is true, iterates in reversed order (next becomes previous)
325 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> nextFeature(
326 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theReverse = false) const;
329 //! Returns (creates if needed) the general label
330 TDF_Label generalLabel() const;
332 //! Creates new document with binary file format
333 Model_Document(const int theID, const std::string theKind);
335 //! Returns the internal OCCT document of this interface
336 Handle_TDocStd_Document document()
341 //! performs compactification of all nested operations into one
342 //! \returns true if resulting transaction is not empty and can be undone
343 void compactNested();
345 //! Returns all loaded sub documents
346 const std::set<int> subDocuments() const;
348 //! The implementation of undo: with or without recursive calls in the sub-documents
349 void undoInternal(const bool theWithSubs, const bool theSynchronize);
351 //! Stores the Id of the current operation (normally is called for the root document)
352 void operationId(const std::string& theId);
354 //! Returns the list of Ids of the operations that can be undone (called for the root document)
355 std::list<std::string> undoList() const;
357 //! Returns the list of Ids of the operations that can be redone (called for the root document)
358 std::list<std::string> redoList() const;
360 //! Internally makes document know that feature was removed or added in history after creation
361 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
362 //! Internally makes document know that feature was removed or added in history after creation
363 virtual void updateHistory(const std::string theGroup);
365 //! Returns true if the document is root module document
368 //! Sets shared pointer to this
369 void setThis(DocumentPtr theDoc);
371 //! Returns the objects manager
372 Model_Objects* objects() {return myObjs;}
374 ///! Informs the document that it becomes active and some actions must be performed
375 virtual void setActive(const bool theFlag);
376 //! Returns true if this document is currently active
377 virtual bool isActive() const;
379 //! Returns the selection attribute that is used
380 //! for calculation of selection externally from the document
381 std::shared_ptr<ModelAPI_AttributeSelectionList> selectionInPartFeature();
383 /// Stores in the document boolean flags: states of the nodes in the object browser.
384 /// Normally is called outside of the transaction, just before "save".
385 virtual void storeNodesState(const std::list<bool>& theStates);
387 /// Returns the stored nodes states. Normally it is called just after "open".
388 /// Appends the values to theStates list.
389 virtual void restoreNodesState(std::list<bool>& theStates) const;
391 /// Label that contains structures for selection of constructions of another document
392 TDF_Label extConstructionsLabel() const;
394 /// searches in this document feature that contains this label
395 FeaturePtr featureByLab(const TDF_Label& theLab);
396 /// searches in this document result that contains this label
397 ResultPtr resultByLab(const TDF_Label& theLab);
399 /// returns true if theThis is later in the features tree and dependencies than theOther
400 bool isLaterByDep(FeaturePtr theThis, FeaturePtr theOther);
402 /// appends the latest transaction to the previous one (used for AutoUpdate enabling transaction)
403 void appendTransactionToPrevious();
405 /// Sets the automatic recomputation flag: true means enabled
406 void setAutoRecomutationState(const bool theState);
407 /// Returns the current automatic recomputation flag: true means enabled
408 bool autoRecomutationState() const;
410 friend class Model_Application;
411 friend class Model_Session;
412 friend class Model_Update;
413 friend class Model_AttributeReference;
414 friend class Model_AttributeRefAttr;
415 friend class Model_AttributeRefList;
416 friend class Model_AttributeRefAttrList;
417 friend class Model_AttributeSelection;
418 friend class Model_AttributeSelectionList;
419 friend class Model_ResultPart;
420 friend class Model_ResultBody;
421 friend class Model_ResultConstruction;
422 friend class Model_SelectionNaming;
423 friend class Model_BodyBuilder;
424 friend class DFBrowser;
427 int myID; ///< identifier of the document in the application
428 std::string myKind; ///< kind of the document in the application
429 Handle_TDocStd_Document myDoc; ///< OCAF document
431 Model_Objects *myObjs; ///< data manager of this document
433 //! counter value of transaction on the last "save" call, used for "IsModified" method
434 int myTransactionSave;
435 //! number of nested transactions performed (list because may be nested inside of nested)
436 //! the list is empty if not nested transaction is performed
437 std::list<int> myNestedNum;
439 //! Information related to the every user-transaction
441 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
442 std::string myId; ///< user-identifier string of transaction
443 //! default constructor with default Id
444 Transaction(): myOCAFNum(0), myId("") {}
447 //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
448 //! in myDocument connected to this operation (may be zero for empty transaction)
449 std::list<Transaction> myTransactions;
450 //! list of info about transactions undone (first is oldest undone)
451 std::list<Transaction> myRedos;
453 //! Optimization for finding the shape-label by topological naming names
454 //! The name -> list of labels where this name is appeared (the last created name is last here)
455 std::map<std::wstring, std::list<TDF_Label> > myNamingNames;
456 //! If it is true, features are not executed on update (on abort, undo, redo)
457 bool myExecuteFeatures;
459 bool myIsActive; ///< flag that stores the active/not active state
461 //! The selection feature, if needed
462 FeaturePtr mySelectionFeature;
464 bool myIsSetCurrentFeature; ///< flag that my current feature is changed right now (recursion)