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_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/retrived in the file.
49 * Also it provides acces 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 hiden
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) = 0;
86 ///! Returns the id of the document
87 virtual const int id() const = 0;
89 //! Returns the object in the group by the index (started from zero)
90 //! \param theGroupID group that contains an object
91 //! \param theIndex zero-based index of feature in the group
92 virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
93 const int theIndex) = 0;
95 //! Returns the first found object in the group by the object name
96 //! \param theGroupID group that contains an object
97 //! \param theName name of the object to search
98 //! \returns null if such object is not found
99 virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
100 const std::string& theName) = 0;
102 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
103 //! \param theObject object of this document
104 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
105 virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
107 //! Returns the number of objects in the group of objects
108 virtual int size(const std::string& theGroupID) = 0;
110 //! Returns the feature that is currently edited in this document, normally
111 //! this is the latest created feature
112 //! \param theVisible use visible features only: flag is true for Object Browser functionality
113 //! \returns null if next created feature must be the first
114 virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
116 //! Sets the current feature: all features below will be disabled, new features
117 //! will be appended after this one. This method does not flushes the events appeared:
118 //! it will be done by the finishOperation, or direct flushes
119 //! \param theCurrent the selected feature as current: blow it everythin become disabled
120 //! \param theVisible use visible features only: flag is true for Object Browser functionality
121 virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
122 const bool theVisible) = 0;
123 //! Makes the current feature one feature upper
124 virtual void setCurrentFeatureUp() = 0;
126 //! Returns the number of all features: in the history or not
127 virtual int numInternalFeatures() = 0;
128 //! Returns the feature by zero-based index: features in the history or not
129 virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
130 //! Performs synchronization of transactions with the module document:
131 //! If some document is not active (by undo of activation) but in memory,
132 //! on activation the transactions must be synchronised because all redos performed
133 //! wihtout this participation
134 virtual void synchronizeTransactions() = 0;
136 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
137 virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId) = 0;
139 //! To virtually destroy the fields of successors
140 MODELAPI_EXPORT virtual ~ModelAPI_Document();
142 //! Creates a construction result
143 virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
144 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
145 //! Creates a body result
146 virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
147 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
148 //! Creates a part result
149 virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
150 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
151 //! Copies a part result, keeping the reference to the origin
152 virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
153 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
154 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
155 //! Creates a group result
156 virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
157 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
158 //! Creates a field result
159 virtual std::shared_ptr<ModelAPI_ResultField> createField(
160 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
161 //! Creates a parameter result
162 virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
163 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
165 //! Returns a feature by result (owner of result)
166 virtual std::shared_ptr<ModelAPI_Feature> feature(
167 const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
169 //! Returns all features of the document including the hidden features which are not in
170 //! history. Not very fast method, for calling once, not in big cycles.
171 virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
173 //! Informs the document that it becomes active and some actions must be performed
174 virtual void setActive(const bool theFlag) = 0;
175 //! Returns true if this document is currently active
176 virtual bool isActive() const = 0;
178 /// Returns true if document is opened and valid
179 virtual bool isOpened() = 0;
181 /// Returns the feature that produced the given face of the given result.
182 virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
183 std::shared_ptr<ModelAPI_Result> theResult,
184 const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
186 /// Returns true if theLater is in history of features creation later than theCurrent
187 virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
188 std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
190 //! Internally makes document know that feature was removed or added in history after creation
191 MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
193 /// Stores in the document boolean flags: states of the nodes in the object browser.
194 /// Normally is called outside of the transaction, just before "save".
195 MODELAPI_EXPORT virtual void storeNodesState(const std::list<bool>& theStates) = 0;
197 /// Returns the stored nodes states. Normally it is calles just after "open".
198 /// Appends the values to theStates list.
199 MODELAPI_EXPORT virtual void restoreNodesState(std::list<bool>& theStates) const = 0;
201 /// Just removes all features without touching the document data (to be able undo)
202 MODELAPI_EXPORT virtual void eraseAllFeatures() = 0;
205 //! Only for SWIG wrapping it is here
206 MODELAPI_EXPORT ModelAPI_Document();
208 //! Internally makes document know that feature was removed or added in history after creation
209 MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
211 friend class ModelAPI_Object; // to add or remove from the history
212 friend class ModelAPI_Result; // to add or remove from the history
215 //! Pointer on document object
216 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;