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 ModelAPI_Document_H_
21 #define ModelAPI_Document_H_
24 #include "ModelAPI_Entity.h"
32 class ModelAPI_Feature;
33 class ModelAPI_Folder;
34 class ModelAPI_Object;
35 class ModelAPI_Result;
36 class ModelAPI_ResultConstruction;
37 class ModelAPI_ResultBody;
38 class ModelAPI_ResultPart;
39 class ModelAPI_ResultGroup;
40 class ModelAPI_ResultField;
41 class ModelAPI_ResultParameter;
45 /**\class ModelAPI_Document
47 * \brief Document for internal data structure of any object storage.
48 * Document contains all data that must be stored/retrieved in the file.
49 * Also it provides access to this data: open/save, transactions management etc.
51 class ModelAPI_Document: public ModelAPI_Entity
54 //! Returns the kind of the document: "PartSet", "Part", or something else.
55 //! This kind is used for feature buttons enable/disable depending on active document
56 //! (it uses workbench "document" identifier in XML configuration file for this)
57 virtual const std::string& kind() const = 0;
59 //! Removes document data
60 //! \param theForever if it is false, document is just hidden
61 //! (to keep possibility make it back on Undo/Redo)
62 virtual void close(const bool theForever = false) = 0;
64 //! Adds to the document the new feature of the given feature id
65 //! \param theID creates feature and puts it in the document (if it is not action)
66 //! \param theMakeCurrent to make current this new feature in this document
67 virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
68 const bool theMakeCurrent = true) = 0;
70 //! Return a list of features, which refers to the feature
71 //! \param theFeature a feature
72 //! \param theRefs a list of features
73 //! \param isSendError a flag whether the error message should be send
74 virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
75 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
76 const bool isSendError = true) = 0;
78 //! Removes the feature from the document
79 //! \param theFeature a feature to be removed
80 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
82 //! Moves the feature to make it after the given one in the history.
83 virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
84 std::shared_ptr<ModelAPI_Feature> theAfterThis,
85 const bool theSplit = false) = 0;
87 ///! Returns the id of the document
88 virtual const int id() const = 0;
90 //! Returns the object in the group by the index (started from zero)
91 //! \param theGroupID group that contains an object
92 //! \param theIndex zero-based index of feature in the group
93 //! \param theAllowFolder take into account grouping feature by folders
94 virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
96 const bool theAllowFolder = false) = 0;
98 //! Returns the first found object in the group by the object name
99 //! \param theGroupID group that contains an object
100 //! \param theName name of the object to search
101 //! \returns null if such object is not found
102 virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
103 const std::string& theName) = 0;
105 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
106 //! \param theObject object of this document
107 //! \param theAllowFolder take into account grouping feature by folders
108 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
109 virtual const int index(std::shared_ptr<ModelAPI_Object> theObject,
110 const bool theAllowFolder = false) = 0;
112 //! Returns the number of objects in the group of objects
113 //! \param theGroupID group of objects
114 //! \param theAllowFolder take into account grouping feature by folders
115 virtual int size(const std::string& theGroupID, const bool theAllowFolder = false) = 0;
117 //! Returns the parent object of this child. This may be result or feature, parent of a
118 //! top result. Fast method, that uses internal data structure specifics.
119 virtual std::shared_ptr<ModelAPI_Object> parent(
120 const std::shared_ptr<ModelAPI_Object> theChild) = 0;
122 //! Returns the feature that is currently edited in this document, normally
123 //! this is the latest created feature
124 //! \param theVisible use visible features only: flag is true for Object Browser functionality
125 //! \returns null if next created feature must be the first
126 virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
128 //! Sets the current feature: all features below will be disabled, new features
129 //! will be appended after this one. This method does not flushes the events appeared:
130 //! it will be done by the finishOperation, or direct flushes
131 //! \param theCurrent the selected feature as current: blow it everything become disabled
132 //! \param theVisible use visible features only: flag is true for Object Browser functionality
133 virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
134 const bool theVisible) = 0;
135 //! Makes the current feature one feature upper
136 virtual void setCurrentFeatureUp() = 0;
138 //! Returns the number of all features: in the history or not
139 virtual int numInternalFeatures() = 0;
140 //! Returns the feature by zero-based index: features in the history or not
141 virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
142 //! Performs synchronization of transactions with the module document:
143 //! If some document is not active (by undo of activation) but in memory,
144 //! on activation the transactions must be synchronized because all redo-s performed
145 //! without this participation
146 virtual void synchronizeTransactions() = 0;
148 //! To virtually destroy the fields of successors
149 MODELAPI_EXPORT virtual ~ModelAPI_Document();
151 //! Creates a construction result
152 virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
153 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
154 //! Creates a body result
155 virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
156 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
157 //! Creates a part result
158 virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
159 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
160 //! Copies a part result, keeping the reference to the origin
161 virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
162 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
163 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
164 //! Creates a group result
165 virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
166 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
167 //! Creates a field result
168 virtual std::shared_ptr<ModelAPI_ResultField> createField(
169 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
170 //! Creates a parameter result
171 virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
172 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
174 //! Returns a feature by result (owner of result)
175 virtual std::shared_ptr<ModelAPI_Feature> feature(
176 const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
178 //! Returns all features of the document including the hidden features which are not in
179 //! history. Not very fast method, for calling once, not in big cycles.
180 virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
182 //! Returns all objects of the document including the hidden features which are not in
183 //! history. Not very fast method, for calling once, not in big cycles.
184 virtual std::list<std::shared_ptr<ModelAPI_Object> > allObjects() = 0;
186 //! Creates a folder (group of the features in the object browser)
187 //! \param theAddBefore a feature, the folder is added before
188 //! (if empty, the folder is added after the last feature)
189 virtual std::shared_ptr<ModelAPI_Folder> addFolder(
190 std::shared_ptr<ModelAPI_Feature> theAddBefore = std::shared_ptr<ModelAPI_Feature>()) = 0;
191 //! Removes the folder from the document (all features in the folder will be kept).
192 virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder) = 0;
193 //! Search a folder above the list of features applicable to store them
194 //! (it means the list of features stored in the folder should be consequential)
195 //! \return Empty pointer if there is no applicable folder
196 virtual std::shared_ptr<ModelAPI_Folder> findFolderAbove(
197 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
198 //! Search a folder below the list of features applicable to store them
199 //! (it means the list of features stored in the folder should be consequential)
200 //! \return Empty pointer if there is no applicable folder
201 virtual std::shared_ptr<ModelAPI_Folder> findFolderBelow(
202 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
203 //! Search a folder containing the given feature.
204 //! Additionally calculates a zero-based index of the feature in this folder.
205 //! \param theFeature feature to search
206 //! \param theIndexInFolder zero-based index in the folder or -1 if the feature is top-level.
207 //! \return the folder containing the feature or empty pointer if the feature is top-level.
208 virtual std::shared_ptr<ModelAPI_Folder> findContainingFolder(
209 const std::shared_ptr<ModelAPI_Feature>& theFeature,
210 int& theIndexInFolder) = 0;
211 //! Add a list of features to the folder. The correctness of the adding is not performed
212 //! (such checks have been done in corresponding find.. method).
213 //! \return \c true if the movement is successful
214 virtual bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
215 const std::shared_ptr<ModelAPI_Folder>& theFolder) = 0;
216 //! Remove features from the folder
217 //! \param theFeatures list of features to be removed
218 //! \param theBefore extract features before the folder (this parameter is applicable only
219 //! when all features in the folder are taking out,
220 //! in other cases the direction is taken automatically)
221 //! \return \c true if the features have been moved out
222 virtual bool removeFromFolder(
223 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
224 const bool theBefore = true) = 0;
226 //! Informs the document that it becomes active and some actions must be performed
227 virtual void setActive(const bool theFlag) = 0;
228 //! Returns true if this document is currently active
229 virtual bool isActive() const = 0;
231 /// Returns true if document is opened and valid
232 virtual bool isOpened() = 0;
234 /// Returns the feature that produced the given face of the given result.
235 virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
236 std::shared_ptr<ModelAPI_Result> theResult,
237 const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
239 /// Returns true if theLater is in history of features creation later than theCurrent
240 virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
241 std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
243 //! Internally makes document know that feature was removed or added in history after creation
244 MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
246 /// Stores in the document boolean flags: states of the nodes in the object browser.
247 /// Normally is called outside of the transaction, just before "save".
248 MODELAPI_EXPORT virtual void storeNodesState(const std::list<bool>& theStates) = 0;
250 /// Returns the stored nodes states. Normally it is calls just after "open".
251 /// Appends the values to theStates list.
252 MODELAPI_EXPORT virtual void restoreNodesState(std::list<bool>& theStates) const = 0;
254 /// Just removes all features without touching the document data (to be able undo)
255 MODELAPI_EXPORT virtual void eraseAllFeatures() = 0;
257 /// Returns the next (from the history point of view) feature, any: invisible or disabled
258 /// \param theCurrent previous to the resulting feature
259 /// \param theReverse if it is true, iterates in reversed order (next becomes previous)
260 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Feature> nextFeature(
261 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theReverse = false) const = 0;
263 /// Loads the OCAF document from the file into the current document.
264 /// All the features are added after the active feature.
265 /// \param theFileName name of the file to import
266 /// \param theImported list of features imported from the file
267 /// \param theCheckOnly verify the document does not contain unappropriate features
268 /// (useful for import to PartSet), but do not import it
269 /// \returns true if file was loaded successfully
270 MODELAPI_EXPORT virtual bool importPart(const char* theFileName,
271 std::list<std::shared_ptr<ModelAPI_Feature> >& theImported,
272 bool theCheckOnly = false) = 0;
274 /// Export the list of features to the file
275 /// \param theFilename path to save the file
276 /// \param theExportFeatures list of features to export
277 MODELAPI_EXPORT virtual bool save(const char* theFilename,
278 const std::list<std::shared_ptr<ModelAPI_Feature> >& theExportFeatures) const = 0;
281 //! Only for SWIG wrapping it is here
282 MODELAPI_EXPORT ModelAPI_Document();
284 //! Internally makes document know that feature was removed or added in history after creation
285 MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
287 friend class ModelAPI_Object; // to add or remove from the history
288 friend class ModelAPI_Result; // to add or remove from the history
291 //! Pointer on document object
292 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;