]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_Data.h
Salome HOME
7743af0ac3aa8bae93bd9afb907f00ab33e0db04
[modules/shaper.git] / src / ModelAPI / ModelAPI_Data.h
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef ModelAPI_Data_H_
21 #define ModelAPI_Data_H_
22
23 #ifdef _WINDOWS // to avoid too long decorated name warning
24 #pragma warning( disable : 4503 )
25 #endif
26
27 #include "ModelAPI.h"
28 #include <string>
29 #include <list>
30 #include <set>
31 #include <memory>
32
33 class ModelAPI_Attribute;
34 class ModelAPI_AttributeDocRef;
35 class ModelAPI_AttributeInteger;
36 class ModelAPI_AttributeDouble;
37 class ModelAPI_AttributeDoubleArray;
38 class ModelAPI_AttributeReference;
39 class ModelAPI_AttributeRefAttr;
40 class ModelAPI_AttributeRefList;
41 class ModelAPI_AttributeRefAttrList;
42 class ModelAPI_AttributeBoolean;
43 class ModelAPI_AttributeString;
44 class ModelAPI_AttributeStringArray;
45 class ModelAPI_Document;
46 class ModelAPI_Attribute;
47 class ModelAPI_Feature;
48 class ModelAPI_AttributeSelection;
49 class ModelAPI_AttributeSelectionList;
50 class ModelAPI_AttributeIntArray;
51 class ModelAPI_AttributeTables;
52 class ModelAPI_Object;
53 class GeomAPI_Shape;
54
55 /// Enumeration that contains the execution status of the Object
56 enum ModelAPI_ExecState {
57   ModelAPI_StateDone, ///< execution was performed and result is up to date
58   ModelAPI_StateMustBeUpdated, ///< execution must be performed to obtain the up to date result
59   ModelAPI_StateExecFailed, ///< execution was failed (results are deleted in this case)
60   ModelAPI_StateInvalidArgument, ///< execution was not performed (results are deleted in this case)
61   ModelAPI_StateNothing ///< internal state that actually means that nothing must be changed
62 };
63
64 /**\class ModelAPI_Data
65  * \ingroup DataModel
66  * \brief General object of the application that allows
67  * to get/set attributes from the document and compute result of an operation.
68  */
69
70 class MODELAPI_EXPORT ModelAPI_Data
71 {
72  public:
73
74   /// Returns the name of the feature visible by the user in the object browser
75   virtual std::wstring name() = 0;
76   /// Defines the name of the feature visible by the user in the object browser
77   virtual void setName(const std::wstring& theName) = 0;
78   /// Return \c true if the object has been renamed by the user
79   virtual bool hasUserDefinedName() const = 0;
80
81   /// Returns version of the feature (empty string if not applicable)
82   virtual std::string version() = 0;
83   /// Initialize the version of the feature
84   virtual void setVersion(const std::string& theVersion) = 0;
85
86   /// Returns the attribute that references to another document
87   virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID) = 0;
88   /// Returns the attribute that contains real value with double precision
89   virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID) = 0;
90   /// Returns the attribute that contains double values array
91   virtual std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID) = 0;
92   /// Returns the attribute that contains integer value
93   virtual std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID) = 0;
94   /// Returns the attribute that contains reference to a feature
95   virtual std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID) = 0;
96   /// Returns the attribute that contains selection to a shape
97   virtual std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID) = 0;
98   /// Returns the attribute that contains selection to a shape
99   virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
100     selectionList(const std::string& theID) = 0;
101   /// Returns the attribute that contains reference to an attribute of a feature
102   virtual std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID) = 0;
103   /// Returns the attribute that contains list of references to features
104   virtual std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID) = 0;
105   /// Returns the attribute that contains list of references to features or reference to
106   /// an attribute of a feature
107   virtual std::shared_ptr<ModelAPI_AttributeRefAttrList> refattrlist(const std::string& theID) = 0;
108   /// Returns the attribute that contains boolean value
109   virtual std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID) = 0;
110   /// Returns the attribute that contains boolean value
111   virtual std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID) = 0;
112   /// Returns the attribute that contains integer values array
113   virtual std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID) = 0;
114   /// Returns the attribute that contains string values array
115   virtual std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID) = 0;
116   /// Returns the attribute that contains tables
117   virtual std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID) = 0;
118
119   /// Returns the generic attribute by identifier
120   /// \param theID identifier of the attribute
121   virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID) = 0;
122   /// Returns all attributes of the feature of the given type
123   /// or all attributes if "theType" is empty
124   virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
125   attributes(const std::string& theType) = 0;
126   /// Returns all attributes ids of the feature of the given type
127   /// or all attributes if "theType" is empty
128   virtual std::list<std::string> attributesIDs(const std::string& theType) = 0;
129   /// Identifier by the id (not fast, iteration by map)
130   /// \param theAttr attribute already created in this data
131   virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr) = 0;
132   /// Returns true if data belongs to same features
133   virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData) = 0;
134   /// Returns true if it is correctly connected to the data model
135   virtual bool isValid() = 0;
136
137   /// Initializes object by the attributes: must be called just after the object is created
138   /// for each attribute of the object
139   /// \param theID identifier of the attribute that can be referenced by this ID later
140   /// \param theAttrType type of the created attribute (received from the type method)
141   /// \param theIndex index of the attribute in the internal data structure, for not-floating
142   ///                 attributes it is -1 to let it automatically be added
143   /// \returns the just created attribute
144   virtual std::shared_ptr<ModelAPI_Attribute> addAttribute(
145     const std::string& theID, const std::string theAttrType, const int theIndex = -1) = 0;
146
147   /// Adds a floating attribute (that may be added/removed during the data life)
148   /// \param theID identifier of the attribute that can be referenced by this ID later
149   /// \param theAttrType type of the created attribute (received from the type method)
150   /// \param theGroup identifier of the group this attribute belongs to, may be an empty string
151   virtual std::shared_ptr<ModelAPI_Attribute>
152     addFloatingAttribute(const std::string& theID, const std::string theAttrType,
153       const std::string& theGroup) = 0;
154
155   /// Returns all groups of this data (ordered).
156   virtual void allGroups(std::list<std::string>& theGroups) = 0;
157
158   /// Returns an ordered list of attributes that belong to the given group
159   virtual void attributesOfGroup(const std::string& theGroup,
160     std::list<std::shared_ptr<ModelAPI_Attribute> >& theAttrs) = 0;
161
162   /// Remove all attributes of the given group
163   virtual void removeAttributes(const std::string& theGroup) = 0;
164
165   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
166   /// makes attribute initialized
167   virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0;
168   /// Blocks sending "attribute updated" if theBlock is true
169   /// \param theID identifier of the attribute that can be referenced by this ID later
170   /// \param theAttrType type of the created attribute (received from the type method)
171   /// \returns the previous state of block
172   virtual bool blockSendAttributeUpdated(
173     const bool theBlock, const bool theSendMessage = true) = 0;
174
175   /// Erases all the data from the data model
176   virtual void erase() = 0;
177
178   /// To virtually destroy the fields of successors
179   virtual ~ModelAPI_Data();
180
181   /// Stores the state of the object to execute it later accordingly
182   virtual void execState(const ModelAPI_ExecState theState) = 0;
183
184   /// Returns the state of the latest execution of the feature
185   virtual ModelAPI_ExecState execState() = 0;
186
187   /// Registers error during the execution, causes the ExecutionFailed state
188   virtual void setError(const std::string& theError, bool theSend = true) = 0;
189
190   /// Returns error, arose during the execution
191   virtual std::string error() const = 0;
192
193   /// Returns the identifier of feature-owner, unique in this document
194   virtual int featureId() const = 0;
195
196   /// returns all objects referenced to this
197   virtual const std::set<std::shared_ptr<ModelAPI_Attribute> >& refsToMe() = 0;
198
199   /// returns all references by attributes of this data
200   /// \param theRefs returned list of pairs: id of referenced attribute and
201   ///                list of referenced objects
202   virtual void referencesToObjects(
203     std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > >& theRefs) =0;
204
205   /// Copies all attributes content into theTarget data
206   virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget) = 0;
207
208   /// Returns the invalid data pointer (to avoid working with NULL shared pointers in swig)
209   virtual std::shared_ptr<ModelAPI_Data> invalidPtr() = 0;
210
211   /// Identifier of the transaction when object (feature or result) was updated last time.
212   virtual int updateID() = 0;
213
214   /// Identifier of the transaction when object (feature or result) was updated last time.
215   /// This method is called by the updater.
216   virtual void setUpdateID(const int theID) = 0;
217
218   /// Returns the owner of this data
219   virtual std::shared_ptr<ModelAPI_Object> owner() = 0;
220
221   /// Returns true if the object is deleted, but some data is still kept in memory
222   virtual bool isDeleted() = 0;
223
224   /// Sets true if the object is deleted, but some data is still kept in memory
225   virtual void setIsDeleted(const bool theFlag) = 0;
226
227   /// Returns \c true if theAttribute1 is going earlier than theAttribute2 in the data
228   virtual bool isPrecedingAttribute(const std::string& theAttribute1,
229                                     const std::string& theAttribute2) const = 0;
230
231  protected:
232   /// Objects are created for features automatically
233   ModelAPI_Data();
234
235   /// Returns true if "is in history" custom behaviors is defined for the feature
236   virtual bool isInHistory() = 0;
237
238   /// Defines the custom "is in history" behavior
239   virtual void setIsInHistory(const bool theFlag) = 0;
240
241   /// Returns true if object must be displayed in the viewer: flag is stored in the
242   /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
243   /// the original state in the current transaction.
244   virtual bool isDisplayed() = 0;
245
246   /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
247   /// signal.
248   virtual void setDisplayed(const bool theDisplay) = 0;
249
250   friend class ModelAPI_Object;
251 };
252
253 typedef std::shared_ptr<ModelAPI_Data> DataPtr;
254
255 #endif