1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Data.hxx
4 // Created: 21 Mar 2014
5 // Author: Mikhail PONIKAROV
11 #include <ModelAPI_Attribute.h>
12 #include <ModelAPI_AttributeBoolean.h>
13 #include <ModelAPI_AttributeDocRef.h>
14 #include <ModelAPI_AttributeDouble.h>
15 #include <ModelAPI_AttributeInteger.h>
16 #include <ModelAPI_AttributeRefAttr.h>
17 #include <ModelAPI_AttributeReference.h>
18 #include <ModelAPI_AttributeRefList.h>
19 #include <ModelAPI_AttributeRefAttrList.h>
20 #include <ModelAPI_AttributeString.h>
21 #include <ModelAPI_AttributeIntArray.h>
22 #include <ModelAPI_Data.h>
23 #include <ModelAPI_Feature.h>
24 #include <ModelAPI_Object.h>
26 #include <TDF_Label.hxx>
27 #include <TDataStd_BooleanArray.hxx>
36 class ModelAPI_Attribute;
40 * \brief General object of the application that allows
41 * to get/set attributes from the document and compute result of an operation.
44 class Model_Data : public ModelAPI_Data
46 TDF_Label myLab; ///< label of the feature in the document
47 /// All attributes of the object identified by the attribute ID
48 std::map<std::string, std::shared_ptr<ModelAPI_Attribute> > myAttrs;
49 /// Array of flags of this data
50 Handle(TDataStd_BooleanArray) myFlags;
52 /// needed here to emit signal that object changed on change of the attribute
55 /// List of attributes referenced to owner (updated only during the transaction change)
56 std::set<AttributePtr> myRefsToMe;
57 /// flag that may block the "attribute updated" sending
58 bool mySendAttributeUpdated;
59 /// if some attribute was changed, but mySendAttributeUpdated was false, this stores this
60 std::list<ModelAPI_Attribute*> myWasChangedButBlocked;
62 /// Returns label of this feature
68 friend class Model_Document;
69 friend class Model_Objects;
70 friend class Model_Update;
71 friend class Model_AttributeReference;
72 friend class Model_AttributeRefAttr;
73 friend class Model_AttributeRefList;
74 friend class Model_AttributeRefAttrList;
75 friend class Model_AttributeSelection;
76 friend class Model_AttributeSelectionList;
77 friend class Model_ValidatorsFactory;
78 friend class Model_SelectionNaming;
81 /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
83 /// Returns the name of the feature visible by the user in the object browser
84 MODEL_EXPORT virtual std::string name();
85 /// Defines the name of the feature visible by the user in the object browser
86 MODEL_EXPORT virtual void setName(const std::string& theName);
87 /// Returns the attribute that references to another document
88 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
89 /// Returns the attribute that contains real value with double precision
90 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
91 /// Returns the attribute that contains double values array
93 std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
94 /// Returns the attribute that contains integer value
95 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
96 integer(const std::string& theID);
97 /// Returns the attribute that contains reference to a feature
98 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeReference>
99 reference(const std::string& theID);
100 /// Returns the attribute that contains selection to a shape
101 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
102 selection(const std::string& theID);
103 /// Returns the attribute that contains selection to a shape
104 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
105 selectionList(const std::string& theID);
106 /// Returns the attribute that contains reference to an attribute of a feature
107 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
108 refattr(const std::string& theID);
109 /// Returns the attribute that contains list of references to features
110 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
111 reflist(const std::string& theID);
112 /// Returns the attribute that contains list of references to features
113 /// or reference to an attribute of a feature
114 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
115 refattrlist(const std::string& theID);
116 /// Returns the attribute that contains boolean value
117 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
118 boolean(const std::string& theID);
119 /// Returns the attribute that contains real value with double precision
120 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeString>
121 string(const std::string& theID);
122 /// Returns the attribute that contains integer values array
123 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
124 intArray(const std::string& theID);
126 /// Returns the generic attribute by identifier
127 /// \param theID identifier of the attribute
128 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
129 /// Returns all attributes of the feature of the given type
130 /// or all attributes if "theType" is empty
131 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
132 attributes(const std::string& theType);
133 /// Returns all attributes ids of the feature of the given type
134 /// or all attributes if "theType" is empty
135 MODEL_EXPORT virtual std::list<std::string> attributesIDs(const std::string& theType);
137 /// Identifier by the id (not fast, iteration by map)
138 /// \param theAttr attribute already created in this data
139 MODEL_EXPORT virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
140 /// Returns true if data belongs to same features
141 MODEL_EXPORT virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData);
142 /// Returns true if it is correctly connected t othe data model
143 MODEL_EXPORT virtual bool isValid();
145 /// Returns the label where the shape must be stored (used in ResultBody)
146 TDF_Label& shapeLab()
151 /// Initializes object by the attributes: must be called just after the object is created
152 /// for each attribute of the object
153 /// \param theID identifier of the attribute that can be referenced by this ID later
154 /// \param theAttrType type of the created attribute (received from the type method)
155 /// \returns the just created attribute
156 MODEL_EXPORT virtual AttributePtr
157 addAttribute(const std::string& theID, const std::string theAttrType);
159 /// Useful method for "set" methods of the attributes: sends an UPDATE event and
160 /// makes attribute initialized
161 MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
162 /// Blocks sending "attribute updated" if theBlock is true
163 /// \param theBlock allows switching on/off the blocking state
164 /// \param theSendMessage if false, it does not send the update message
165 /// even if something is changed
166 /// (normally is it used in attributeChanged because this message will be sent anyway)
167 MODEL_EXPORT virtual void blockSendAttributeUpdated(
168 const bool theBlock, const bool theSendMessage = true);
170 /// Puts feature to the document data sub-structure
171 MODEL_EXPORT void setLabel(TDF_Label theLab);
173 /// Sets the object of this data
174 MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
176 myObject = theObject;
179 /// Erases all the data from the data model
180 MODEL_EXPORT virtual void erase();
182 /// Stores the state of the object to execute it later accordingly
183 MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
185 /// Returns the state of the latest execution of the feature
186 MODEL_EXPORT virtual ModelAPI_ExecState execState();
188 /// Registers error during the execution, causes the ExecutionFailed state
189 MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
191 /// Erases the error string if it is not empty
192 void eraseErrorString();
194 /// Registers error during the execution, causes the ExecutionFailed state
195 MODEL_EXPORT virtual std::string error() const;
197 /// Returns the identifier of feature-owner, unique in this document
198 MODEL_EXPORT virtual int featureId() const;
200 /// returns all objects referenced to this
201 MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
203 /// returns all references by attributes of this data
204 /// \param theRefs returned list of pairs:
205 /// id of referenced attribute and list of referenced objects
206 MODEL_EXPORT virtual void referencesToObjects(
207 std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
209 /// Copies all atributes content into theTarget data
210 MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
212 /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig)
213 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
215 /// Returns the invalid data pointer: static method
216 static std::shared_ptr<ModelAPI_Data> invalidData();
218 /// Identifier of the transaction when object (feature or result) was updated last time.
219 MODEL_EXPORT virtual int updateID();
221 /// Identifier of the transaction when object (feature or result) was updated last time.
222 /// This method is called by the updater.
223 MODEL_EXPORT virtual void setUpdateID(const int theID);
225 /// Returns true if the given object is owner of this data (needed for correct erase of object
226 /// with duplicated data)
227 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
230 /// Returns true if "is in history" custom behaviors is defined for the feature
231 MODEL_EXPORT virtual bool isInHistory();
233 /// Defines the custom "is in history" behavior
234 MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
236 /// Returns true if the object is deleted, but some data is still keept in memory
237 MODEL_EXPORT virtual bool isDeleted();
239 /// Sets true if the object is deleted, but some data is still keept in memory
240 MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
243 /// Removes all information about back references
244 void eraseBackReferences();
245 /// Removes a back reference (with identifier which attribute references to this object)
246 /// \param theFeature feature referenced to this
247 /// \param theAttrID identifier of the attribute that is references from theFeature to this
248 void removeBackReference(FeaturePtr theFeature, std::string theAttrID);
249 /// Removes a back reference (by the attribute)
250 /// \param theAttr the referenced attribute
251 void removeBackReference(AttributePtr theAttr);
252 /// Adds a back reference (with identifier which attribute references to this object
253 /// \param theFeature feature referenced to this
254 /// \param theAttrID identifier of the attribute that is references from theFeature to this
255 /// \param theApplyConcealment applies consealment flag changes
256 void addBackReference(FeaturePtr theFeature, std::string theAttrID,
257 const bool theApplyConcealment = true);
259 /// Makes the concealment flag up to date for this object-owner.
260 MODEL_EXPORT virtual void updateConcealmentFlag();
262 /// Returns true if object must be displayed in the viewer: flag is stored in the
263 /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
264 /// the original state i nthe current transaction.
265 MODEL_EXPORT virtual bool isDisplayed();
267 /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
269 MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
272 /// Generic method to register back reference, used in referencing attributes.
273 /// Without concealment change, it will be done later, on synchronization.
274 #define ADD_BACK_REF(TARGET) \
275 if (TARGET.get() != NULL) { \
276 FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
277 if (anAttributeOwnerFeature.get()) { \
278 std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
280 aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
284 /// Generic method to unregister back reference, used in referencing attributes.
285 /// Without concealment change, it will be done later, on synchronization.
286 #define REMOVE_BACK_REF(TARGET) \
287 if (TARGET.get() != NULL) { \
288 FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
289 if (anAttOwnerFeature.get()) { \
290 std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
292 aTargetData->removeBackReference(anAttOwnerFeature, id()); \