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 ModelAPI_Document_H_
22 #define ModelAPI_Document_H_
25 #include "ModelAPI_Entity.h"
33 class ModelAPI_Feature;
34 class ModelAPI_Folder;
35 class ModelAPI_Object;
36 class ModelAPI_Result;
37 class ModelAPI_ResultConstruction;
38 class ModelAPI_ResultBody;
39 class ModelAPI_ResultPart;
40 class ModelAPI_ResultGroup;
41 class ModelAPI_ResultField;
42 class ModelAPI_ResultParameter;
46 /**\class ModelAPI_Document
48 * \brief Document for internal data structure of any object storage.
49 * Document contains all data that must be stored/retrived in the file.
50 * Also it provides acces to this data: open/save, transactions management etc.
52 class ModelAPI_Document: public ModelAPI_Entity
55 //! Returns the kind of the document: "PartSet", "Part", or something else.
56 //! This kind is used for feature buttons enable/disable depending on active document
57 //! (it uses workbench "document" identifier in XML configuration file for this)
58 virtual const std::string& kind() const = 0;
60 //! Removes document data
61 //! \param theForever if it is false, document is just hiden
62 //! (to keep possibility make it back on Undo/Redo)
63 virtual void close(const bool theForever = false) = 0;
65 //! Adds to the document the new feature of the given feature id
66 //! \param theID creates feature and puts it in the document (if it is not action)
67 //! \param theMakeCurrent to make current this new feature in this document
68 virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
69 const bool theMakeCurrent = true) = 0;
71 //! Return a list of features, which refers to the feature
72 //! \param theFeature a feature
73 //! \param theRefs a list of features
74 //! \param isSendError a flag whether the error message should be send
75 virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
76 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
77 const bool isSendError = true) = 0;
79 //! Removes the feature from the document
80 //! \param theFeature a feature to be removed
81 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
83 //! Moves the feature to make it after the given one in the history.
84 virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
85 std::shared_ptr<ModelAPI_Feature> theAfterThis) = 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 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
108 virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
110 //! Returns the number of objects in the group of objects
111 //! \param theGroupID group of objects
112 //! \param theAllowFolder take into account grouping feature by folders
113 virtual int size(const std::string& theGroupID, const bool theAllowFolder = false) = 0;
115 //! Returns the feature that is currently edited in this document, normally
116 //! this is the latest created feature
117 //! \param theVisible use visible features only: flag is true for Object Browser functionality
118 //! \returns null if next created feature must be the first
119 virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
121 //! Sets the current feature: all features below will be disabled, new features
122 //! will be appended after this one. This method does not flushes the events appeared:
123 //! it will be done by the finishOperation, or direct flushes
124 //! \param theCurrent the selected feature as current: blow it everythin become disabled
125 //! \param theVisible use visible features only: flag is true for Object Browser functionality
126 virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
127 const bool theVisible) = 0;
128 //! Makes the current feature one feature upper
129 virtual void setCurrentFeatureUp() = 0;
131 //! Returns the number of all features: in the history or not
132 virtual int numInternalFeatures() = 0;
133 //! Returns the feature by zero-based index: features in the history or not
134 virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
135 //! Performs synchronization of transactions with the module document:
136 //! If some document is not active (by undo of activation) but in memory,
137 //! on activation the transactions must be synchronised because all redos performed
138 //! wihtout this participation
139 virtual void synchronizeTransactions() = 0;
141 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
142 virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId) = 0;
144 //! To virtually destroy the fields of successors
145 MODELAPI_EXPORT virtual ~ModelAPI_Document();
147 //! Creates a construction result
148 virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
149 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
150 //! Creates a body result
151 virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
152 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
153 //! Creates a part result
154 virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
155 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
156 //! Copies a part result, keeping the reference to the origin
157 virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
158 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
159 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
160 //! Creates a group result
161 virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
162 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
163 //! Creates a field result
164 virtual std::shared_ptr<ModelAPI_ResultField> createField(
165 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
166 //! Creates a parameter result
167 virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
168 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
170 //! Returns a feature by result (owner of result)
171 virtual std::shared_ptr<ModelAPI_Feature> feature(
172 const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
174 //! Returns all features of the document including the hidden features which are not in
175 //! history. Not very fast method, for calling once, not in big cycles.
176 virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
178 //! Returns all objects 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_Object> > allObjects() = 0;
182 //! Creates a folder (group of the features in the object browser)
183 virtual std::shared_ptr<ModelAPI_Folder> addFolder(
184 std::shared_ptr<ModelAPI_Feature> theAddBefore) = 0;
185 //! Removes the folder from the document (all features in the folder will be kept).
186 virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder) = 0;
187 //! Search a folder above the list of features applicable to store them
188 //! (it means the list of features stored in the folder should be consequential)
189 //! \return Empty pointer if there is no applicable folder
190 virtual std::shared_ptr<ModelAPI_Folder> findFolderAbove(
191 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
192 //! Search a folder below the list of features applicable to store them
193 //! (it means the list of features stored in the folder should be consequential)
194 //! \return Empty pointer if there is no applicable folder
195 virtual std::shared_ptr<ModelAPI_Folder> findFolderBelow(
196 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
197 //! Add a list of features to the folder. The correctness of the adding is not performed
198 //! (such checks have been done in corresponding find.. method).
199 //! \return \c true if the movement is successfull
200 virtual bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
201 const std::shared_ptr<ModelAPI_Folder>& theFolder) = 0;
202 //! Remove features from the folder
203 //! \return \c true if the features have been moved out
204 virtual bool removeFromFolder(
205 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
207 //! Informs the document that it becomes active and some actions must be performed
208 virtual void setActive(const bool theFlag) = 0;
209 //! Returns true if this document is currently active
210 virtual bool isActive() const = 0;
212 /// Returns true if document is opened and valid
213 virtual bool isOpened() = 0;
215 /// Returns the feature that produced the given face of the given result.
216 virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
217 std::shared_ptr<ModelAPI_Result> theResult,
218 const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
220 /// Returns true if theLater is in history of features creation later than theCurrent
221 virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
222 std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
224 //! Internally makes document know that feature was removed or added in history after creation
225 MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
227 /// Stores in the document boolean flags: states of the nodes in the object browser.
228 /// Normally is called outside of the transaction, just before "save".
229 MODELAPI_EXPORT virtual void storeNodesState(const std::list<bool>& theStates) = 0;
231 /// Returns the stored nodes states. Normally it is calles just after "open".
232 /// Appends the values to theStates list.
233 MODELAPI_EXPORT virtual void restoreNodesState(std::list<bool>& theStates) const = 0;
235 /// Just removes all features without touching the document data (to be able undo)
236 MODELAPI_EXPORT virtual void eraseAllFeatures() = 0;
239 //! Only for SWIG wrapping it is here
240 MODELAPI_EXPORT ModelAPI_Document();
242 //! Internally makes document know that feature was removed or added in history after creation
243 MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
245 friend class ModelAPI_Object; // to add or remove from the history
246 friend class ModelAPI_Result; // to add or remove from the history
249 //! Pointer on document object
250 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;