1 // File: Model_Document.h
2 // Created: 28 Feb 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef Model_Document_HeaderFile
6 #define Model_Document_HeaderFile
9 #include <ModelAPI_Document.h>
10 #include <ModelAPI_Feature.h>
11 #include <ModelAPI_Result.h>
13 #include <TDocStd_Document.hxx>
14 #include <NCollection_DataMap.hxx>
15 #include <TDF_Label.hxx>
19 class Handle_Model_Document;
21 // for TDF_Label map usage
22 static Standard_Integer HashCode(const TDF_Label& theLab,const Standard_Integer theUpper);
23 static Standard_Boolean IsEqual(const TDF_Label& theLab1,const TDF_Label& theLab2);
25 /**\class Model_Document
27 * \brief Document for internal data structure of any object storage.
28 * Document contains all data that must be stored/retrived in the file.
29 * Also it provides acces to this data: open/save, transactions management etc.
31 class Model_Document: public ModelAPI_Document
35 //! Loads the OCAF document from the file.
36 //! \param theFileName full name of the file to load
37 //! \param theStudyID identifier of the SALOME study to associate with loaded file
38 //! \returns true if file was loaded successfully
39 MODEL_EXPORT virtual bool load(const char* theFileName);
41 //! Saves the OCAF document to the file.
42 //! \param theFileName full name of the file to store
43 //! \returns true if file was stored successfully
44 MODEL_EXPORT virtual bool save(const char* theFileName);
46 //! Removes document data
47 MODEL_EXPORT virtual void close();
49 //! Starts a new operation (opens a tansaction)
50 MODEL_EXPORT virtual void startOperation();
51 //! Finishes the previously started operation (closes the transaction)
52 //! Returns true if transaction in this document is not empty and really was performed
53 MODEL_EXPORT virtual void finishOperation();
54 //! Aborts the operation
55 MODEL_EXPORT virtual void abortOperation();
56 //! Returns true if operation has been started, but not yet finished or aborted
57 MODEL_EXPORT virtual bool isOperation();
58 //! Returns true if document was modified (since creation/opening)
59 MODEL_EXPORT virtual bool isModified();
61 //! Returns True if there are available Undos
62 MODEL_EXPORT virtual bool canUndo();
63 //! Undoes last operation
64 MODEL_EXPORT virtual void undo();
65 //! Returns True if there are available Redos
66 MODEL_EXPORT virtual bool canRedo();
67 //! Redoes last operation
68 MODEL_EXPORT virtual void redo();
70 //! Adds to the document the new feature of the given feature id
71 //! \param creates feature and puts it in the document
72 MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID);
74 //! Removes the feature from the document (with result)
75 MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature);
77 //! Returns the existing feature by the label
78 //! \param theLabel base label of the feature
79 MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel);
81 //! Returns the existing object: result or feature
82 //! \param theLabel base label of the object
83 MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel);
85 //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
86 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
88 ///! Returns the id of hte document
89 MODEL_EXPORT virtual const std::string& id() const {return myID;}
91 //! Returns the feature in the group by the index (started from zero)
92 //! \param theGroupID group that contains a feature
93 //! \param theIndex zero-based index of feature in the group
94 //! \param isOperation if it is true, returns feature (not Object)
95 //! \param theHidden if it is true, it counts also the features that are not in tree
96 MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex,
97 const bool theHidden = false);
99 //! Returns the number of features in the group
100 //! If theHidden is true, it counts also the features that are not in tree
101 MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false);
103 /// Creates a construction cresults
104 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
105 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
106 /// Creates a body results
107 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultBody> createBody(
108 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
109 /// Creates a part results
110 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_ResultPart> createPart(
111 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
113 //! Returns a feature by result (owner of result)
114 MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature>
115 feature(const boost::shared_ptr<ModelAPI_Result>& theResult);
120 //! Returns (creates if needed) the features label
121 TDF_Label featuresLabel();
123 //! Initializes feature with a unique name in this group (unique name is generated as
124 //! feature type + "_" + index
125 void setUniqueName(FeaturePtr theFeature);
127 //! Synchronizes myFeatures list with the updated document
128 void synchronizeFeatures(const bool theMarkUpdated = false);
130 //! Creates new document with binary file format
131 Model_Document(const std::string theID);
133 Handle_TDocStd_Document document() {return myDoc;}
135 //! performas compactification of all nested operations into one
136 void compactNested();
138 //! Initializes the data fields of the feature
139 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
141 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
142 MODEL_EXPORT virtual void storeResult(boost::shared_ptr<ModelAPI_Data> theFeatureData,
143 boost::shared_ptr<ModelAPI_Result> theResult, const int theResultIndex = 0);
146 friend class Model_Application;
147 friend class Model_PluginManager;
148 friend class DFBrowser;
151 std::string myID; ///< identifier of the document in the application
152 Handle_TDocStd_Document myDoc; ///< OCAF document
153 /// number of transactions after the last "save" call, used for "IsModified" method
154 int myTransactionsAfterSave;
155 /// number of nested transactions performed (or -1 if not nested)
157 /// All features managed by this document (not only in history of OB)
158 /// For optimization mapped by labels
159 NCollection_DataMap<TDF_Label, FeaturePtr> myObjs;
161 ///< set of identifiers of sub-documents of this document
162 std::set<std::string> mySubs;
163 /// transaction indexes (related to myTransactionsAfterSave) which were empty in this doc
164 std::map<int, bool> myIsEmptyTr;