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;
80 /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
82 /// Returns the name of the feature visible by the user in the object browser
83 MODEL_EXPORT virtual std::string name();
84 /// Defines the name of the feature visible by the user in the object browser
85 MODEL_EXPORT virtual void setName(const std::string& theName);
86 /// Returns the attribute that references to another document
87 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
88 /// Returns the attribute that contains real value with double precision
89 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
90 /// Returns the attribute that contains double values array
91 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
92 /// Returns the attribute that contains integer value
93 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
94 integer(const std::string& theID);
95 /// Returns the attribute that contains reference to a feature
96 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeReference>
97 reference(const std::string& theID);
98 /// Returns the attribute that contains selection to a shape
99 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
100 selection(const std::string& theID);
101 /// Returns the attribute that contains selection to a shape
102 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
103 selectionList(const std::string& theID);
104 /// Returns the attribute that contains reference to an attribute of a feature
105 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
106 refattr(const std::string& theID);
107 /// Returns the attribute that contains list of references to features
108 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
109 reflist(const std::string& theID);
110 /// Returns the attribute that contains list of references to features
111 /// or reference to an attribute of a feature
112 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
113 refattrlist(const std::string& theID);
114 /// Returns the attribute that contains boolean value
115 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
116 boolean(const std::string& theID);
117 /// Returns the attribute that contains real value with double precision
118 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeString>
119 string(const std::string& theID);
120 /// Returns the attribute that contains integer values array
121 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
122 intArray(const std::string& theID);
124 /// Returns the generic attribute by identifier
125 /// \param theID identifier of the attribute
126 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
127 /// Returns all attributes of the feature of the given type
128 /// or all attributes if "theType" is empty
129 MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
130 attributes(const std::string& theType);
131 /// Returns all attributes ids of the feature of the given type
132 /// or all attributes if "theType" is empty
133 MODEL_EXPORT virtual std::list<std::string> attributesIDs(const std::string& theType);
135 /// Identifier by the id (not fast, iteration by map)
136 /// \param theAttr attribute already created in this data
137 MODEL_EXPORT virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
138 /// Returns true if data belongs to same features
139 MODEL_EXPORT virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData);
140 /// Returns true if it is correctly connected t othe data model
141 MODEL_EXPORT virtual bool isValid();
143 /// Returns the label where the shape must be stored (used in ResultBody)
144 TDF_Label& shapeLab()
149 /// Initializes object by the attributes: must be called just after the object is created
150 /// for each attribute of the object
151 /// \param theID identifier of the attribute that can be referenced by this ID later
152 /// \param theAttrType type of the created attribute (received from the type method)
153 /// \returns the just created attribute
154 MODEL_EXPORT virtual AttributePtr
155 addAttribute(const std::string& theID, const std::string theAttrType);
157 /// Useful method for "set" methods of the attributes: sends an UPDATE event and
158 /// makes attribute initialized
159 MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
160 /// Blocks sending "attribute updated" if theBlock is true
161 /// \param theBlock allows switching on/off the blocking state
162 /// \param theSendMessage if false, it does not send the update message even if something is changed
163 /// (normally is it used in attributeChanged because this message will be sent anyway)
164 MODEL_EXPORT virtual void blockSendAttributeUpdated(
165 const bool theBlock, const bool theSendMessage = true);
167 /// Puts feature to the document data sub-structure
168 MODEL_EXPORT void setLabel(TDF_Label theLab);
170 /// Sets the object of this data
171 MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
173 myObject = theObject;
176 /// Erases all the data from the data model
177 MODEL_EXPORT virtual void erase();
179 /// Stores the state of the object to execute it later accordingly
180 MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
182 /// Returns the state of the latest execution of the feature
183 MODEL_EXPORT virtual ModelAPI_ExecState execState();
185 /// Registers error during the execution, causes the ExecutionFailed state
186 MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
188 /// Erases the error string if it is not empty
189 void eraseErrorString();
191 /// Registers error during the execution, causes the ExecutionFailed state
192 MODEL_EXPORT virtual std::string error() const;
194 /// Returns the identifier of feature-owner, unique in this document
195 MODEL_EXPORT virtual int featureId() const;
197 /// returns all objects referenced to this
198 MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
200 /// returns all references by attributes of this data
201 /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects
202 MODEL_EXPORT virtual void referencesToObjects(
203 std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
205 /// Copies all atributes content into theTarget data
206 MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
208 /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig)
209 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
211 /// Returns the invalid data pointer: static method
212 static std::shared_ptr<ModelAPI_Data> invalidData();
214 /// Identifier of the transaction when object (feature or result) was updated last time.
215 MODEL_EXPORT virtual int updateID();
217 /// Identifier of the transaction when object (feature or result) was updated last time.
218 /// This method is called by the updater.
219 MODEL_EXPORT virtual void setUpdateID(const int theID);
221 /// Returns true if the given object is owner of this data (needed for correct erase of object
222 /// with duplicated data)
223 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
226 /// Returns true if "is in history" custom behaviors is defined for the feature
227 MODEL_EXPORT virtual bool isInHistory();
229 /// Defines the custom "is in history" behavior
230 MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
232 /// Returns true if the object is deleted, but some data is still keept in memory
233 MODEL_EXPORT virtual bool isDeleted();
235 /// Sets true if the object is deleted, but some data is still keept in memory
236 MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
239 /// Removes all information about back references
240 void eraseBackReferences();
241 /// Removes a back reference (with identifier which attribute references to this object)
242 /// \param theFeature feature referenced to this
243 /// \param theAttrID identifier of the attribute that is references from theFeature to this
244 void removeBackReference(FeaturePtr theFeature, std::string theAttrID);
245 /// Removes a back reference (by the attribute)
246 /// \param theAttr the referenced attribute
247 void removeBackReference(AttributePtr theAttr);
248 /// Adds a back reference (with identifier which attribute references to this object
249 /// \param theFeature feature referenced to this
250 /// \param theAttrID identifier of the attribute that is references from theFeature to this
251 /// \param theApplyConcealment applies consealment flag changes
252 void addBackReference(FeaturePtr theFeature, std::string theAttrID,
253 const bool theApplyConcealment = true);
255 /// Makes the concealment flag up to date for this object-owner.
256 MODEL_EXPORT virtual void updateConcealmentFlag();
258 /// Returns true if object must be displayed in the viewer: flag is stored in the
259 /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
260 /// the original state i nthe current transaction.
261 MODEL_EXPORT virtual bool isDisplayed();
263 /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
265 MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
268 /// Generic method to register back reference, used in referencing attributes.
269 /// Without concealment change, it will be done later, on synchronization.
270 #define ADD_BACK_REF(TARGET) \
271 if (TARGET.get() != NULL) { \
272 FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
273 if (anAttributeOwnerFeature.get()) { \
274 std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
276 aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
280 /// Generic method to unregister back reference, used in referencing attributes.
281 /// Without concealment change, it will be done later, on synchronization.
282 #define REMOVE_BACK_REF(TARGET) \
283 if (TARGET.get() != NULL) { \
284 FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
285 if (anAttOwnerFeature.get()) { \
286 std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
288 aTargetData->removeBackReference(anAttOwnerFeature, id()); \