]> SALOME platform Git repositories - modules/shaper.git/blob - src/Model/Model_Data.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / Model / Model_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 Model_Data_H_
21 #define Model_Data_H_
22
23 #include <Model.h>
24 #include <ModelAPI_Attribute.h>
25 #include <ModelAPI_AttributeBoolean.h>
26 #include <ModelAPI_AttributeDocRef.h>
27 #include <ModelAPI_AttributeDouble.h>
28 #include <ModelAPI_AttributeInteger.h>
29 #include <ModelAPI_AttributeRefAttr.h>
30 #include <ModelAPI_AttributeReference.h>
31 #include <ModelAPI_AttributeRefList.h>
32 #include <ModelAPI_AttributeRefAttrList.h>
33 #include <ModelAPI_AttributeString.h>
34 #include <ModelAPI_AttributeStringArray.h>
35 #include <ModelAPI_AttributeIntArray.h>
36 #include <ModelAPI_Data.h>
37 #include <ModelAPI_Feature.h>
38 #include <ModelAPI_Folder.h>
39 #include <ModelAPI_Object.h>
40
41 #include <TDF_Label.hxx>
42 #include <TDataStd_BooleanArray.hxx>
43
44 #include <memory>
45
46 #include <map>
47 #include <list>
48 #include <string>
49 #include <set>
50
51 class ModelAPI_Attribute;
52
53 /**\class Model_Data
54  * \ingroup DataModel
55  * \brief General object of the application that allows
56  * to get/set attributes from the document and compute result of an operation.
57  */
58
59 class Model_Data : public ModelAPI_Data
60 {
61   typedef std::map<std::string, std::pair<std::shared_ptr<ModelAPI_Attribute>, int> > AttributeMap;
62
63   TDF_Label myLab;  ///< label of the feature in the document
64   /// All attributes of the object identified by the attribute ID
65   /// (the attribute is stored together with its index in the feature)
66   AttributeMap myAttrs;
67   /// Array of flags of this data
68   Handle(TDataStd_BooleanArray) myFlags;
69
70   /// needed here to emit signal that object changed on change of the attribute
71   ObjectPtr myObject;
72
73   /// List of attributes referenced to owner (updated only during the transaction change)
74   std::set<AttributePtr> myRefsToMe;
75   /// flag that may block the "attribute updated" sending
76   bool mySendAttributeUpdated;
77   /// if some attribute was changed, but mySendAttributeUpdated was false, this stores this
78   std::list<ModelAPI_Attribute*> myWasChangedButBlocked;
79
80   /// Returns label of this feature
81   TDF_Label label()
82   {
83     return myLab;
84   }
85
86   friend class Model_Document;
87   friend class Model_Objects;
88   friend class Model_Update;
89   friend class Model_AttributeReference;
90   friend class Model_AttributeRefAttr;
91   friend class Model_AttributeRefList;
92   friend class Model_AttributeRefAttrList;
93   friend class Model_AttributeSelection;
94   friend class Model_AttributeSelectionList;
95   friend class Model_ValidatorsFactory;
96   friend class Model_SelectionNaming;
97   friend class Model_ResultConstruction;
98   friend class Model_ResultBody;
99
100  public:
101   /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
102   Model_Data();
103   /// Returns the name of the feature visible by the user in the object browser
104   MODEL_EXPORT virtual std::string name();
105   /// Defines the name of the feature visible by the user in the object browser
106   MODEL_EXPORT virtual void setName(const std::string& theName);
107   /// Return \c true if the object has been renamed by the user
108   MODEL_EXPORT virtual bool hasUserDefinedName() const;
109   /// Returns the attribute that references to another document
110   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
111   /// Returns the attribute that contains real value with double precision
112   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
113   /// Returns the attribute that contains double values array
114   MODEL_EXPORT virtual
115     std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
116   /// Returns the attribute that contains integer value
117   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
118     integer(const std::string& theID);
119   /// Returns the attribute that contains reference to a feature
120   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeReference>
121     reference(const std::string& theID);
122   /// Returns the attribute that contains selection to a shape
123   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
124     selection(const std::string& theID);
125   /// Returns the attribute that contains selection to a shape
126   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
127     selectionList(const std::string& theID);
128   /// Returns the attribute that contains reference to an attribute of a feature
129   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
130     refattr(const std::string& theID);
131   /// Returns the attribute that contains list of references to features
132   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
133     reflist(const std::string& theID);
134   /// Returns the attribute that contains list of references to features
135   /// or reference to an attribute of a feature
136   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
137     refattrlist(const std::string& theID);
138   /// Returns the attribute that contains boolean value
139   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
140     boolean(const std::string& theID);
141   /// Returns the attribute that contains real value with double precision
142   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeString>
143     string(const std::string& theID);
144   /// Returns the attribute that contains integer values array
145   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
146     intArray(const std::string& theID);
147   /// Returns the attribute that contains string values array
148   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeStringArray>
149     stringArray(const std::string& theID);
150   /// Returns the attribute that contains string values array
151   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeTables>
152     tables(const std::string& theID);
153
154   /// Returns the generic attribute by identifier
155   /// \param theID identifier of the attribute
156   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
157   /// Returns all attributes of the feature of the given type
158   /// or all attributes if "theType" is empty
159   MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
160     attributes(const std::string& theType);
161   /// Returns all attributes ids of the feature of the given type
162   /// or all attributes if "theType" is empty
163   MODEL_EXPORT virtual std::list<std::string> attributesIDs(const std::string& theType);
164
165   /// Identifier by the id (not fast, iteration by map)
166   /// \param theAttr attribute already created in this data
167   MODEL_EXPORT virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
168   /// Returns true if data belongs to same features
169   MODEL_EXPORT virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData);
170   /// Returns true if it is correctly connected to the data model
171   MODEL_EXPORT virtual bool isValid();
172
173   /// Returns the label where the shape must be stored (used in ResultBody)
174   TDF_Label shapeLab() const
175   {
176     return myLab.IsNull() ? myLab : myLab.Father().FindChild(2);
177   }
178
179   /// Initializes object by the attributes: must be called just after the object is created
180   /// for each attribute of the object
181   /// \param theID identifier of the attribute that can be referenced by this ID later
182   /// \param theAttrType type of the created attribute (received from the type method)
183   /// \param theIndex index of the attribute in the internal data structure, for not-floating
184   ///                 attributes it is -1 to let it automatically be added
185   /// \returns the just created attribute
186   MODEL_EXPORT virtual AttributePtr
187     addAttribute(const std::string& theID, const std::string theAttrType, const int theIndex = -1);
188
189   /// Adds a floating attribute (that may be added/removed during the data life)
190   /// \param theID identifier of the attribute that can be referenced by this ID later
191   /// \param theAttrType type of the created attribute (received from the type method)
192   /// \param theGroup identifier of the group this attribute belongs to, may be an empty string
193   MODEL_EXPORT virtual AttributePtr
194     addFloatingAttribute(const std::string& theID, const std::string theAttrType,
195       const std::string& theGroup);
196
197   /// Returns all groups of this data (ordered).
198   MODEL_EXPORT virtual void allGroups(std::list<std::string>& theGroups);
199
200   /// Returns an ordered list of attributes that belong to the given group
201   MODEL_EXPORT virtual void attributesOfGroup(const std::string& theGroup,
202     std::list<std::shared_ptr<ModelAPI_Attribute> >& theAttrs);
203
204   /// Remove all attributes of the given group
205   MODEL_EXPORT virtual void removeAttributes(const std::string& theGroup);
206
207   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
208   /// makes attribute initialized
209   MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
210   /// Blocks sending "attribute updated" if theBlock is true
211   /// \param theBlock allows switching on/off the blocking state
212   /// \param theSendMessage if false, it does not send the update message
213   ///            even if something is changed
214   ///            (normally is it used in attributeChanged because this message will be sent anyway)
215   /// \returns the previous state of block
216   MODEL_EXPORT virtual bool blockSendAttributeUpdated(
217     const bool theBlock, const bool theSendMessage = true);
218
219   /// Puts feature to the document data sub-structure
220   MODEL_EXPORT void setLabel(TDF_Label theLab);
221
222   /// Sets the object of this data
223   MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
224   {
225     myObject = theObject;
226   }
227
228   /// Erases all the data from the data model
229   MODEL_EXPORT virtual void erase();
230
231   /// Stores the state of the object to execute it later accordingly
232   MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
233
234   /// Returns the state of the latest execution of the feature
235   MODEL_EXPORT virtual ModelAPI_ExecState execState();
236
237   /// Registers error during the execution, causes the ExecutionFailed state
238   MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
239
240   /// Erases the error string if it is not empty
241   void eraseErrorString();
242
243   /// Registers error during the execution, causes the ExecutionFailed state
244   MODEL_EXPORT virtual std::string error() const;
245
246   /// Returns the identifier of feature-owner, unique in this document
247   MODEL_EXPORT virtual int featureId() const;
248
249   /// returns all objects referenced to this
250   MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
251
252   /// returns all references by attributes of this data
253   /// \param theRefs returned list of pairs:
254   ///                id of referenced attribute and list of referenced objects
255   MODEL_EXPORT virtual void referencesToObjects(
256     std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
257
258   /// Copies all attributes content into theTarget data
259   MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
260
261   /// Returns the invalid data pointer (to avoid working with NULL shared pointers in swig)
262   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
263
264   /// Returns the invalid data pointer: static method
265   static std::shared_ptr<ModelAPI_Data> invalidData();
266
267   /// Identifier of the transaction when object (feature or result) was updated last time.
268   MODEL_EXPORT virtual int updateID();
269
270   /// Identifier of the transaction when object (feature or result) was updated last time.
271   /// This method is called by the updater.
272   MODEL_EXPORT virtual void setUpdateID(const int theID);
273
274   /// Returns true if the given object is owner of this data (needed for correct erase of object
275   /// with duplicated data)
276   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
277
278 protected:
279   /// Returns true if "is in history" custom behaviors is defined for the feature
280   MODEL_EXPORT virtual bool isInHistory();
281
282   /// Defines the custom "is in history" behavior
283   MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
284
285   /// Returns true if the object is deleted, but some data is still kept in memory
286   MODEL_EXPORT virtual bool isDeleted();
287
288   /// Sets true if the object is deleted, but some data is still kept in memory
289   MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
290
291   /// Erases all attributes from myAttrs, but keeping them in the data structure
292   void clearAttributes();
293
294 private:
295   /// Removes a back reference (with identifier which attribute references to this object)
296   /// \param theFeature feature referenced to this
297   /// \param theAttrID identifier of the attribute that is references from theFeature to this
298   void removeBackReference(ObjectPtr theObject, std::string theAttrID);
299   /// Removes a back reference (by the attribute)
300   /// \param theAttr the referenced attribute
301   void removeBackReference(AttributePtr theAttr);
302   /// Adds a back reference (with identifier which attribute references to this object
303   /// \param theFeature feature referenced to this
304   /// \param theAttrID identifier of the attribute that is references from theFeature to this
305   /// \param theApplyConcealment applies concealment flag changes
306   void addBackReference(FeaturePtr theFeature, std::string theAttrID,
307     const bool theApplyConcealment = true);
308   /// Adds a back reference to an object
309   /// \param theObject object referenced to this
310   /// \param theAttrID identifier of the attribute that is references from theFolder to this
311   void addBackReference(ObjectPtr theObject, std::string theAttrID);
312
313   /// Makes the concealment flag up to date for this object-owner.
314   MODEL_EXPORT virtual void updateConcealmentFlag();
315
316   /// Returns true if object must be displayed in the viewer: flag is stored in the
317   /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
318   /// the original state in the current transaction.
319   MODEL_EXPORT virtual bool isDisplayed();
320
321   /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
322   /// signal.
323   MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
324
325   /// Returns \c true if theAttribute1 is going earlier than theAttribute2 in the data
326   MODEL_EXPORT virtual bool isPrecedingAttribute(const std::string& theAttribute1,
327                                                  const std::string& theAttribute2) const;
328
329   friend class Model_Objects;
330 };
331
332 /// Generic method to register back reference, used in referencing attributes.
333 /// Without concealment change, it will be done later, on synchronization.
334 #define ADD_BACK_REF(TARGET) \
335   if (TARGET.get() != NULL) { \
336     std::shared_ptr<Model_Data> aTargetData = \
337         std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
338     FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
339     if (anAttributeOwnerFeature.get()) \
340       aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
341     else { \
342       FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
343       if (anAttributeOwnerFolder.get()) \
344         aTargetData->addBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \
345     } \
346   }
347
348 /// Generic method to unregister back reference, used in referencing attributes.
349 /// Without concealment change, it will be done later, on synchronization.
350 #define REMOVE_BACK_REF(TARGET) \
351   if (TARGET.get() != NULL) { \
352     std::shared_ptr<Model_Data> aTargetData = \
353         std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
354     FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
355     if (anAttOwnerFeature.get()) \
356       aTargetData->removeBackReference(anAttOwnerFeature, id()); \
357     else { \
358       FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
359       if (anAttributeOwnerFolder.get()) \
360         aTargetData->removeBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \
361     } \
362   }
363
364 #endif