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 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
126 MODEL_EXPORT virtual const int index(std::shared_ptr<ModelAPI_Object> theObject);
128 //! Internal sub-document by ID
129 MODEL_EXPORT virtual std::shared_ptr<Model_Document> subDoc(int theDocID);
131 ///! Returns the id of the document
132 MODEL_EXPORT virtual const int id() const
137 //! Returns the feature in the group by the index (started from zero)
138 //! \param theGroupID group that contains a feature
139 //! \param theIndex zero-based index of feature in the group
140 //! \param theAllowFolder take into account grouping feature by folders
141 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID,
143 const bool theAllowFolder = false);
145 //! Returns the number of features in the group
146 //! \param theGroupID group of objects
147 //! \param theAllowFolder take into account grouping feature by folders
148 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theAllowFolder = false);
150 //! Returns the feature that is currently edited in this document, normally
151 //! this is the latest created feature
152 //! \param theVisible use visible features only: flag is true for Object Browser functionality
153 //! \returns null if next created feature must be the first
154 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible);
156 //! Sets the current feature: all features below will be disabled, new features
157 //! will be appended after this one.
158 //! \param theCurrent the selected feature as current: below it everything becomes disabled
159 //! \param theVisible use visible features only: flag is true for Object Browser functionality
160 MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
161 const bool theVisible);
163 //! Makes the current feature one feature upper
164 MODEL_EXPORT virtual void setCurrentFeatureUp();
166 //! Returns the number of all features: in the history or not
167 MODEL_EXPORT virtual int numInternalFeatures();
168 //! Returns the feature by zero-based index: features in the history or not
169 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
170 //! Performs synchronization of transactions with the module document:
171 //! If some document is not active (by undo of activation) but in memory,
172 //! on activation the transactions must be synchronised because all redos performed
173 //! wihtout this participation
174 MODEL_EXPORT virtual void synchronizeTransactions();
176 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
177 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
180 /// Creates a construction cresults
181 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
182 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
183 /// Creates a body results
184 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
185 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
186 /// Creates a part results
187 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
188 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
189 //! Copies a part result, keeping the reference to origin
190 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
191 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
192 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
193 /// Creates a group result
194 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
195 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
196 /// Creates a field result
197 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultField> createField(
198 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
199 /// Creates a parameter result
200 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
201 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
203 //! Returns a feature by result (owner of result)
204 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
205 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
207 //! Creates a folder (group of the features in the object browser)
208 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Folder> addFolder(
209 std::shared_ptr<ModelAPI_Feature> theAddBefore = std::shared_ptr<ModelAPI_Feature>());
210 //! Removes the folder from the document (all features in the folder will be kept).
211 MODEL_EXPORT virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
213 ///! Returns true if parametric updater need to execute feature on recomputartion
214 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
215 bool& executeFeatures() {return myExecuteFeatures;}
217 //! Registers the name of the shape for the topological naming needs
218 void addNamingName(const TDF_Label theLabel, std::string theName);
219 //! Updates the name of some object
220 void changeNamingName(std::string theOldName, const std::string theNewName,
221 const TDF_Label& theLabel);
222 //! Returns the label, keeper of the name for the topological naming needs
223 TDF_Label findNamingName(std::string theName, ResultPtr theContext);
224 //! Returns the number of the name in the history relatively to the given object (by label).
225 //! Start from 1 (this object).
226 int numberOfNameInHistory(const ObjectPtr& theNameObject, const TDF_Label& theStartFrom);
227 //! Returns the result by name of the result (names of results must be unique, used for naming
228 //! selection by name.
229 ResultPtr findByName(std::string& theName, std::string& theSubShapeName, bool& theUniqueContext);
231 ///! Returns all features of the document including the hidden features which are not in
232 ///! history. Not very fast method, for calling once, not in big cycles.
233 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
235 //! Returns all objects of the document including the hidden features which are not in
236 //! history. Not very fast method, for calling once, not in big cycles.
237 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
239 /// Returns the global identifier of the current transaction (needed for the update algo)
240 MODEL_EXPORT virtual int transactionID();
241 /// Increases the transaction ID
242 MODEL_EXPORT virtual void incrementTransactionID();
243 /// Decreases the transaction ID
244 MODEL_EXPORT virtual void decrementTransactionID();
246 /// Returns true if document is opened and valid
247 MODEL_EXPORT virtual bool isOpened();
249 /// Returns the last feature in the document (even not visible or disabled)
250 /// \returns null if there is no features
251 FeaturePtr lastFeature();
253 /// Returns the feature that produced the given face of the given result.
254 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
255 std::shared_ptr<ModelAPI_Result> theResult,
256 const std::shared_ptr<GeomAPI_Shape>& theShape);
258 /// Returns true if theLater is in history of features creation later than theCurrent
259 MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
261 /// Just removes all features without touching the document data (to be able undo)
262 MODEL_EXPORT virtual void eraseAllFeatures();
266 //! Returns (creates if needed) the general label
267 TDF_Label generalLabel() const;
269 //! Creates new document with binary file format
270 Model_Document(const int theID, const std::string theKind);
272 //! Returns the internal OCCT document of this interface
273 Handle_TDocStd_Document document()
278 //! performs compactification of all nested operations into one
279 //! \returns true if resulting transaction is not empty and can be undoed
280 void compactNested();
282 //! Returns all loaded sub documents
283 const std::set<int> subDocuments() const;
285 //! The implementation of undo: with or without recoursive calls in the sub-documents
286 void undoInternal(const bool theWithSubs, const bool theSynchronize);
288 //! Stores the Id of the current operation (normally is called for the root document)
289 void operationId(const std::string& theId);
291 //! Returns the list of Ids of the operations that can be undoed (called for the root document)
292 std::list<std::string> undoList() const;
294 //! Returns the list of Ids of the operations that can be redoed (called for the root document)
295 std::list<std::string> redoList() const;
297 //! Internally makes document know that feature was removed or added in history after creation
298 virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
299 //! Internally makes document know that feature was removed or added in history after creation
300 virtual void updateHistory(const std::string theGroup);
302 //! Returns true if the document is root module document
305 //! Sets shared pointer to this
306 void setThis(DocumentPtr theDoc);
308 //! Returns the objects manager
309 Model_Objects* objects() {return myObjs;}
311 ///! Informs the document that it becomes active and some actions must be performed
312 virtual void setActive(const bool theFlag);
313 //! Returns true if this document is currently active
314 virtual bool isActive() const;
316 //! Returns the selection attribute that is used
317 //! for calculation of selection externally from the document
318 std::shared_ptr<ModelAPI_AttributeSelectionList> selectionInPartFeature();
320 /// Stores in the document boolean flags: states of the nodes in the object browser.
321 /// Normally is called outside of the transaction, just before "save".
322 virtual void storeNodesState(const std::list<bool>& theStates);
324 /// Returns the stored nodes states. Normally it is calles just after "open".
325 /// Appends the values to theStates list.
326 virtual void restoreNodesState(std::list<bool>& theStates) const;
328 /// Label that constains structures for selection of constructions of another document
329 TDF_Label extConstructionsLabel() const;
331 /// searches in this document feature that contains this label
332 FeaturePtr featureByLab(const TDF_Label& theLab);
334 /// returns true if theThis is later in the features trre and dependencies than theOther
335 bool isLaterByDep(FeaturePtr theThis, FeaturePtr theOther);
337 friend class Model_Application;
338 friend class Model_Session;
339 friend class Model_Update;
340 friend class Model_AttributeReference;
341 friend class Model_AttributeRefAttr;
342 friend class Model_AttributeRefList;
343 friend class Model_AttributeRefAttrList;
344 friend class Model_AttributeSelection;
345 friend class Model_ResultPart;
346 friend class Model_ResultCompSolid;
347 friend class Model_ResultConstruction;
348 friend class Model_SelectionNaming;
349 friend class DFBrowser;
352 int myID; ///< identifier of the document in the application
353 std::string myKind; ///< kind of the document in the application
354 Handle_TDocStd_Document myDoc; ///< OCAF document
356 Model_Objects *myObjs; ///< data manager of this document
358 //! counter value of transaction on the last "save" call, used for "IsModified" method
359 int myTransactionSave;
360 //! number of nested transactions performed (list becasue may be nested inside of nested)
361 //! the list is empty if not nested transaction is performed
362 std::list<int> myNestedNum;
364 //! Information related to the every user-transaction
366 int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0
367 std::string myId; ///< user-identifier string of transaction
368 //! default constructor with default Id
369 Transaction(): myOCAFNum(0), myId("") {}
372 //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions
373 //! in myDocument connected to this operation (may be zero for empty transaction)
374 std::list<Transaction> myTransactions;
375 //! list of info about transactions undone (first is oldest undone)
376 std::list<Transaction> myRedos;
378 //! Optimization for finding the shape-label by topological naming names
379 //! The name -> list of labels where this name is appeared (the last created name is last here)
380 std::map<std::string, std::list<TDF_Label> > myNamingNames;
381 //! If it is true, features are not executed on update (on abort, undo, redo)
382 bool myExecuteFeatures;
384 bool myIsActive; ///< flag that stores the active/not active state
386 //! The selection feature, if needed
387 FeaturePtr mySelectionFeature;