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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef Model_Document_H_
22 #define Model_Document_H_
25 #include <ModelAPI_Document.h>
26 #include <ModelAPI_Feature.h>
27 #include <ModelAPI_Result.h>
28 #include <ModelAPI_ResultParameter.h>
30 #include <TDocStd_Document.hxx>
34 class Handle_Model_Document;
36 class ModelAPI_AttributeSelectionList;
38 /**\class Model_Document
40 * \brief Document for internal data structure of any object storage.
41 * Document contains all data that must be stored/retrived in the file.
42 * Also it provides acces to this data: open/save, transactions management etc.
44 class Model_Document : public ModelAPI_Document
47 //! Returns the kind of the document: "PartSet", "Part", or something else.
48 //! This kind is used for feature buttons enable/disable depending on active document
49 //! (it uses workbench "document" identifier in XML configuration file for this)
50 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
52 //! Loads the OCAF document from the file.
53 //! \param theDirName directory of the loaded file
54 //! \param theFileName a name of the file to load
55 //! \param theThis the common shared pointer to the document to manage with it later
56 //! \returns true if file was loaded successfully
57 MODEL_EXPORT virtual bool load(
58 const char* theDirName, const char* theFileName, DocumentPtr theThis);
60 //! Saves the OCAF document to the file.
61 //! \param theDirName directory where the document will be saved
62 //! \param theFileName a name of the document file to store
63 //! \param theResults the result full file names that were stored by "save"
64 //! \returns true if file was stored successfully
65 MODEL_EXPORT virtual bool save(
66 const char* theDirName, const char* theFileName, std::list<std::string>& theResults);
68 //! Removes document data
69 //! \param theForever if it is false, document is just hiden
70 //! (to keep possibility make it back on Undo/Redo)
71 MODEL_EXPORT virtual void close(const bool theForever = false);
73 //! Starts a new operation (opens a tansaction)
74 MODEL_EXPORT virtual void startOperation();
75 //! Finishes the previously started operation (closes the transaction)
76 //! \returns true if transaction in this document is not empty and really was performed
77 MODEL_EXPORT virtual bool finishOperation();
78 //! Aborts the operation
79 MODEL_EXPORT virtual void abortOperation();
80 //! Returns true if operation has been started, but not yet finished or aborted
81 MODEL_EXPORT virtual bool isOperation() const;
82 //! Returns true if document was modified (since creation/opening)
83 MODEL_EXPORT virtual bool isModified();
85 //! Returns True if there are available Undos
86 MODEL_EXPORT virtual bool canUndo();
87 //! Undoes last operation
88 MODEL_EXPORT virtual void undo();
89 //! Returns True if there are available Redos
90 MODEL_EXPORT virtual bool canRedo();
91 //! Redoes last operation
92 MODEL_EXPORT virtual void redo();
94 //! Adds to the document the new feature of the given feature id
95 //! \param theID creates feature and puts it in the document
96 //! \param theMakeCurrent to make current this new feature in this document
97 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true);
99 //! Return a list of features, which refers to the feature
100 //! \param theFeature a feature
101 //! \param theRefs a list of reference features
102 //! \param isSendError a flag whether the error message should be send
103 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
104 std::set<FeaturePtr>& theRefs,
105 const bool isSendError = true);
107 //! Removes the feature from the document (with result)
108 //! It is necessary to flush REDISPLAY signal manually after this method because
109 //! the method sends it, but for the performance purpose does not flush it
110 //! \param theFeature a removed feature
111 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
113 //! Moves the feature to make it after the given one in the history.
114 MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
116 //! Returns the first found object in the group by the object name
117 //! \param theGroupID group that contains an object
118 //! \param theName name of the object to search
119 //! \returns null if such object is not found
120 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> objectByName(
121 const std::string& theGroupID, const std::string& theName);
123 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
124 //! \param theObject object of this document
125 //! \param theAllowFolder take into account grouping feature by folders
126 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
127 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject,
128 const bool theAllowFolder = false);
130 //! Internal sub-document by ID
131 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(int theDocID);
133 ///! Returns the id of the document
134 MODEL_EXPORT virtual const int id() const
139 //! Returns the feature in the group by the index (started from zero)
140 //! \param theGroupID group that contains a feature
141 //! \param theIndex zero-based index of feature in the group
142 //! \param theAllowFolder take into account grouping feature by folders
143 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID,
145 const bool theAllowFolder = false);
147 //! Returns the number of features in the group
148 //! \param theGroupID group of objects
149 //! \param theAllowFolder take into account grouping feature by folders
150 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theAllowFolder = false);
152 //! Returns the parent object of this child. This may be result or feature, parent of a
153 //! top result. Fast method, that uses internal data structure specifics.
154 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> parent(
155 const std::shared_ptr<ModelAPI_Object> theChild);
157 //! Returns the feature that is currently edited in this document, normally
158 //! this is the latest created feature
159 //! \param theVisible use visible features only: flag is true for Object Browser functionality
160 //! \returns null if next created feature must be the first
161 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
163 //! Sets the current feature: all features below will be disabled, new features
164 //! will be appended after this one.
165 //! \param theCurrent the selected feature as current: below it everything becomes disabled
166 //! \param theVisible use visible features only: flag is true for Object Browser functionality
167 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
168 const bool theVisible);
170 //! Makes the current feature one feature upper
171 MODEL_EXPORT virtual void setCurrentFeatureUp();
173 //! Returns the number of all features: in the history or not
174 MODEL_EXPORT virtual int numInternalFeatures();
175 //! Returns the feature by zero-based index: features in the history or not
176 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
177 //! Performs synchronization of transactions with the module document:
178 //! If some document is not active (by undo of activation) but in memory,
179 //! on activation the transactions must be synchronised because all redos performed
180 //! wihtout this participation
181 MODEL_EXPORT virtual void synchronizeTransactions();
183 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
184 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
187 /// Creates a construction cresults
188 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
189 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
190 /// Creates a body results
191 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
192 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
193 /// Creates a part results
194 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
195 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
196 //! Copies a part result, keeping the reference to origin
197 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
198 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
199 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
200 /// Creates a group result
201 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
202 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
203 /// Creates a field result
204 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultField> createField(
205 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
206 /// Creates a parameter result
207 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
208 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
210 //! Returns a feature by result (owner of result)
211 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
212 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
214 //! Creates a folder (group of the features in the object browser)
215 //! \param theAddBefore a feature, the folder is added before
216 //! (if empty, the folder is added after the last feature)
217 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> addFolder(
218 std::shared_ptr<ModelAPI_Feature> theAddBefore = std::shared_ptr<ModelAPI_Feature>());
219 //! Removes the folder from the document (all features in the folder will be kept).
220 MODEL_EXPORT virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
221 //! Search a folder above the list of features applicable to store them
222 //! (it means the list of features stored in the folder should be consequential)
223 //! \return Empty pointer if there is no applicable folder
224 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findFolderAbove(
225 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures);
226 //! Search a folder below the list of features applicable to store them
227 //! (it means the list of features stored in the folder should be consequential)
228 //! \return Empty pointer if there is no applicable folder
229 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findFolderBelow(
230 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures);
231 //! Search a folder containing the given feature.
232 //! Addtionally calculates a zero-based index of the feature in this folder.
233 //! \param theFeature feature to search
234 //! \param theIndexInFolder zero-based index in the folder or -1 if the feature is top-level.
235 //! \return the folder containing the feature or empty pointer if the feature is top-level.
236 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> findContainingFolder(
237 const std::shared_ptr<ModelAPI_Feature>& theFeature,
238 int& theIndexInFolder);
239 //! Add a list of features to the folder. The correctness of the adding is not performed
240 //! (such checks have been done in corresponding find.. method).
241 //! \return \c true if the movement is successfull
242 MODEL_EXPORT virtual bool moveToFolder(
243 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
244 const std::shared_ptr<ModelAPI_Folder>& theFolder);
245 //! Remove features from the folder
246 //! \param theFeatures list of features to be removed
247 //! \param theBefore extract features before the folder (this parameter is applicable only
248 //! when all features in the folder are taking out,
249 //! in other cases the direction is taken automatically)
250 //! \return \c true if the features have been moved out
251 MODEL_EXPORT virtual bool removeFromFolder(
252 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
253 const bool theBefore = true);
255 ///! Returns true if parametric updater need to execute feature on recomputartion
256 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
257 bool executeFeatures() {return myExecuteFeatures;}
259 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
260 void setExecuteFeatures(const bool theFlag);
262 //! Registers the name of the shape for the topological naming needs
263 void addNamingName(const TDF_Label theLabel, std::string theName);
264 //! Updates the name of some object
265 void changeNamingName(std::string theOldName, const std::string theNewName,
266 const TDF_Label& theLabel);
267 //! Returns the label, keeper of the name for the topological naming needs
268 TDF_Label findNamingName(std::string theName, ResultPtr theContext);
269 //! Returns the number of the name in the history relatively to the given object (by label).
270 //! Start from 1 (this object).
271 int numberOfNameInHistory(const ObjectPtr& theNameObject, const TDF_Label& theStartFrom);
272 //! Returns the result by name of the result (names of results must be unique, used for naming
273 //! selection by name.
274 ResultPtr findByName(std::string& theName, std::string& theSubShapeName, bool& theUniqueContext);
276 ///! Returns all features of the document including the hidden features which are not in
277 ///! history. Not very fast method, for calling once, not in big cycles.
278 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
280 //! Returns all objects of the document including the hidden features which are not in
281 //! history. Not very fast method, for calling once, not in big cycles.
282 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
284 /// Returns the global identifier of the current transaction (needed for the update algo)
285 MODEL_EXPORT virtual int transactionID();
286 /// Increases the transaction ID
287 MODEL_EXPORT virtual void incrementTransactionID();
288 /// Decreases the transaction ID
289 MODEL_EXPORT virtual void decrementTransactionID();
291 /// Returns true if document is opened and valid
292 MODEL_EXPORT virtual bool isOpened();
294 /// Returns the last feature in the document (even not visible or disabled)
295 /// \returns null if there is no features
296 FeaturePtr lastFeature();
298 /// Returns the feature that produced the given face of the given result.
299 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
300 std::shared_ptr<ModelAPI_Result> theResult,
301 const std::shared_ptr<GeomAPI_Shape>& theShape);
303 /// Returns true if theLater is in history of features creation later than theCurrent
304 MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
306 /// Just removes all features without touching the document data (to be able undo)
307 MODEL_EXPORT virtual void eraseAllFeatures();
311 //! Returns (creates if needed) the general label
312 TDF_Label generalLabel() const;
314 //! Creates new document with binary file format
315 Model_Document(const int theID, const std::string theKind);
317 //! Returns the internal OCCT document of this interface
318 Handle_TDocStd_Document document()
323 //! performs compactification of all nested operations into one
324 //! \returns true if resulting transaction is not empty and can be undoed
325 void compactNested();
327 //! Returns all loaded sub documents
328 const std::set<int> subDocuments() const;
330 //! The implementation of undo: with or without recoursive calls in the sub-documents
331 void undoInternal(const bool theWithSubs, const bool theSynchronize);
333 //! Stores the Id of the current operation (normally is called for the root document)
334 void operationId(const std::string& theId);
336 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
337 std::list<std::string> undoList() const;
339 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
340 std::list<std::string> redoList() const;
342 //! Internally makes document know that feature was removed or added in history after creation
343 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
344 //! Internally makes document know that feature was removed or added in history after creation
345 virtual void updateHistory(const std::string theGroup);
347 //! Returns true if the document is root module document
350 //! Sets shared pointer to this
351 void setThis(DocumentPtr theDoc);
353 //! Returns the objects manager
354 Model_Objects* objects() {return myObjs;}
356 ///! Informs the document that it becomes active and some actions must be performed
357 virtual void setActive(const bool theFlag);
358 //! Returns true if this document is currently active
359 virtual bool isActive() const;
361 //! Returns the selection attribute that is used
362 //! for calculation of selection externally from the document
363 std::shared_ptr<ModelAPI_AttributeSelectionList> selectionInPartFeature();
365 /// Stores in the document boolean flags: states of the nodes in the object browser.
366 /// Normally is called outside of the transaction, just before "save".
367 virtual void storeNodesState(const std::list<bool>& theStates);
369 /// Returns the stored nodes states. Normally it is calles just after "open".
370 /// Appends the values to theStates list.
371 virtual void restoreNodesState(std::list<bool>& theStates) const;
373 /// Label that constains structures for selection of constructions of another document
374 TDF_Label extConstructionsLabel() const;
376 /// searches in this document feature that contains this label
377 FeaturePtr featureByLab(const TDF_Label& theLab);
379 /// returns true if theThis is later in the features trre and dependencies than theOther
380 bool isLaterByDep(FeaturePtr theThis, FeaturePtr theOther);
382 friend class Model_Application;
383 friend class Model_Session;
384 friend class Model_Update;
385 friend class Model_AttributeReference;
386 friend class Model_AttributeRefAttr;
387 friend class Model_AttributeRefList;
388 friend class Model_AttributeRefAttrList;
389 friend class Model_AttributeSelection;
390 friend class Model_ResultPart;
391 friend class Model_ResultBody;
392 friend class Model_ResultConstruction;
393 friend class Model_SelectionNaming;
394 friend class DFBrowser;
397 int myID; ///< identifier of the document in the application
398 std::string myKind; ///< kind of the document in the application
399 Handle_TDocStd_Document myDoc; ///< OCAF document
401 Model_Objects *myObjs; ///< data manager of this document
403 //! counter value of transaction on the last "save" call, used for "IsModified" method
404 int myTransactionSave;
405 //! number of nested transactions performed (list becasue may be nested inside of nested)
406 //! the list is empty if not nested transaction is performed
407 std::list<int> myNestedNum;
409 //! Information related to the every user-transaction
411 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
412 std::string myId; ///< user-identifier string of transaction
413 //! default constructor with default Id
414 Transaction(): myOCAFNum(0), myId("") {}
417 //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
418 //! in myDocument connected to this operation (may be zero for empty transaction)
419 std::list<Transaction> myTransactions;
420 //! list of info about transactions undone (first is oldest undone)
421 std::list<Transaction> myRedos;
423 //! Optimization for finding the shape-label by topological naming names
424 //! The name -> list of labels where this name is appeared (the last created name is last here)
425 std::map<std::string, std::list<TDF_Label> > myNamingNames;
426 //! If it is true, features are not executed on update (on abort, undo, redo)
427 bool myExecuteFeatures;
429 bool myIsActive; ///< flag that stores the active/not active state
431 //! The selection feature, if needed
432 FeaturePtr mySelectionFeature;
434 bool myIsSetCurrentFeature; ///< flag that my current feature is changed right now (recursion)