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>
15 #include <TDocStd_Document.hxx>
16 #include <NCollection_DataMap.hxx>
17 #include <TDF_Label.hxx>
21 class Handle_Model_Document;
23 // for TDF_Label map usage
24 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
25 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
27 /**\class Model_Document
29 * \brief Document for internal data structure of any object storage.
30 * Document contains all data that must be stored/retrived in the file.
31 * Also it provides acces to this data: open/save, transactions management etc.
33 class Model_Document : public ModelAPI_Document
36 //! Returns the kind of the document: "PartSet", "Part", or something else.
37 //! This kind is used for feature buttons enable/disable depending on active document
38 //! (it uses workbench "document" identifier in XML configuration file for this)
39 MODEL_EXPORT virtual const std::string& kind() const {return myKind;}
41 //! Loads the OCAF document from the file.
42 //! \param theFileName full name of the file to load
43 //! \returns true if file was loaded successfully
44 MODEL_EXPORT virtual bool load(const char* theFileName);
46 //! Saves the OCAF document to the file.
47 //! \param theFileName full name of the file to store
48 //! \param theResults the result full file names that were stored by "save"
49 //! \returns true if file was stored successfully
50 MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
52 //! Removes document data
53 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
54 MODEL_EXPORT virtual void close(const bool theForever = false);
56 //! Starts a new operation (opens a tansaction)
57 MODEL_EXPORT virtual void startOperation();
58 //! Finishes the previously started operation (closes the transaction)
59 //! \returns true if transaction in this document is not empty and really was performed
60 MODEL_EXPORT virtual bool finishOperation();
61 //! Aborts the operation
62 MODEL_EXPORT virtual void abortOperation();
63 //! Returns true if operation has been started, but not yet finished or aborted
64 MODEL_EXPORT virtual bool isOperation();
65 //! Returns true if document was modified (since creation/opening)
66 MODEL_EXPORT virtual bool isModified();
68 //! Returns True if there are available Undos
69 MODEL_EXPORT virtual bool canUndo();
70 //! Undoes last operation
71 MODEL_EXPORT virtual void undo();
72 //! Returns True if there are available Redos
73 MODEL_EXPORT virtual bool canRedo();
74 //! Redoes last operation
75 MODEL_EXPORT virtual void redo();
77 //! Adds to the document the new feature of the given feature id
78 //! \param theID creates feature and puts it in the document
79 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
81 //! Return a list of features, which refers to the feature
82 //! \param theFeature a feature
83 //! \param theRefs a list of reference features
84 //! \param isSendError a flag whether the error message should be send
85 MODEL_EXPORT virtual void refsToFeature(FeaturePtr theFeature,
86 std::set<FeaturePtr>& theRefs,
87 const bool isSendError = true);
89 //! Removes the feature from the document (with result)
90 //! \param theFeature a removed feature
91 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
93 //! Returns the existing feature by the label
94 //! \param theLabel base label of the feature
95 MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel) const;
97 //! Returns the existing object: result or feature
98 //! \param theLabel base label of the object
99 MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
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 //! \param theHidden if it is true, it counts also the features that are not in tree
117 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
118 const bool theHidden = false);
120 //! Returns the number of features in the group
121 //! If theHidden is true, it counts also the features that are not in tree
122 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
124 /// Creates a construction cresults
125 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
126 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
127 /// Creates a body results
128 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
129 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
130 /// Creates a part results
131 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
132 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
133 /// Creates a group results
134 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
135 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
137 //! Returns a feature by result (owner of result)
138 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
139 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
141 ///! Returns true if parametric updater need to execute feature on recomputartion
142 ///! On abort, undo or redo it is not necessary: results in document are updated automatically
143 bool executeFeatures() {return myExecuteFeatures;}
145 //! Registers the name of the shape for the topological naming needs
146 void addNamingName(const TDF_Label theLabel, std::string theName);
147 //! Returns the label, keeper of the name for the topological naming needs
148 TDF_Label findNamingName(std::string theName);
149 //! Returns the result by name of the result (names of results must be unique, used for naming
150 //! selection by name.
151 ResultPtr findByName(const std::string theName);
155 //! Returns (creates if needed) the features label
156 TDF_Label featuresLabel() const;
158 //! Initializes feature with a unique name in this group (unique name is generated as
159 //! feature type + "_" + index
160 void setUniqueName(FeaturePtr theFeature);
162 //! Synchronizes myFeatures list with the updated document
163 //! \param theMarkUpdated causes the "update" event for all features
164 //! \param theUpdateReferences causes the update of back-references
165 void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences);
166 //! Synchronizes the BackReferences list in Data of Features and Results
167 void synchronizeBackRefs();
169 //! Creates new document with binary file format
170 Model_Document(const std::string theID, const std::string theKind);
172 //! Returns the internal OCCT document of this interface
173 Handle_TDocStd_Document document()
178 //! performs compactification of all nested operations into one
179 //! \returns true if resulting transaction is not empty and can be undoed
180 void compactNested();
182 //! Initializes the data fields of the feature
183 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
185 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
186 MODEL_EXPORT virtual void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
187 std::shared_ptr<ModelAPI_Result> theResult,
188 const int theResultIndex = 0);
190 //! returns the label of result by index; creates this label if it was not created before
191 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
193 //! Updates the results list of the feature basing on the current data tree
194 void updateResults(FeaturePtr theFeature);
196 //! Returns all sub documents
197 const std::set<std::string> subDocuments(const bool theActivatedOnly) const;
199 //! The implementation of undo: with or without recoursive calls in the sub-documents
200 void undoInternal(const bool theWithSubs, const bool theSynchronize);
202 friend class Model_Application;
203 friend class Model_Session;
204 friend class Model_Update;
205 friend class Model_AttributeReference;
206 friend class DFBrowser;
209 std::string myID; ///< identifier of the document in the application
210 std::string myKind; ///< kind of the document in the application
211 Handle_TDocStd_Document myDoc; ///< OCAF document
213 /// counter value of transaction on the last "save" call, used for "IsModified" method
214 int myTransactionSave;
215 /// number of nested transactions performed (list becasue may be nested inside of nested)
216 /// the list is empty if not nested transaction is performed
217 std::list<int> myNestedNum;
219 /// transaction indexes (related to myTransactionsAfterSave) and number of real transactions
220 /// in myDocument connected to this operation (may be zero for empty transaction)
221 std::list<int> myTransactions;
222 /// list of numbers of real document transactions undone (first is oldest undone)
223 std::list<int> myRedos;
224 /// All features managed by this document (not only in history of OB)
225 /// For optimization mapped by labels
226 NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
227 /// Optimization for finding the shape-label by topological naming names
228 std::map<std::string, TDF_Label> myNamingNames;
229 /// If it is true, features are not executed on update (on abort, undo, redo)
230 bool myExecuteFeatures;