1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
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>
41 #include <TDF_Label.hxx>
42 #include <TDataStd_BooleanArray.hxx>
51 class ModelAPI_Attribute;
55 * \brief General object of the application that allows
56 * to get/set attributes from the document and compute result of an operation.
59 class Model_Data : public ModelAPI_Data
61 typedef std::map<std::string, std::pair<std::shared_ptr<ModelAPI_Attribute>, int> > AttributeMap;
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)
67 /// Array of flags of this data
68 Handle(TDataStd_BooleanArray) myFlags;
70 /// needed here to emit signal that object changed on change of the attribute
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;
80 /// Returns label of this feature
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;
101 /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
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
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);
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);
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();
173 /// Returns the label where the shape must be stored (used in ResultBody)
174 TDF_Label shapeLab() const
176 return myLab.IsNull() ? myLab : myLab.Father().FindChild(2);
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 /// \returns the just created attribute
184 MODEL_EXPORT virtual AttributePtr
185 addAttribute(const std::string& theID, const std::string theAttrType);
187 /// Useful method for "set" methods of the attributes: sends an UPDATE event and
188 /// makes attribute initialized
189 MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
190 /// Blocks sending "attribute updated" if theBlock is true
191 /// \param theBlock allows switching on/off the blocking state
192 /// \param theSendMessage if false, it does not send the update message
193 /// even if something is changed
194 /// (normally is it used in attributeChanged because this message will be sent anyway)
195 /// \returns the previous state of block
196 MODEL_EXPORT virtual bool blockSendAttributeUpdated(
197 const bool theBlock, const bool theSendMessage = true);
199 /// Puts feature to the document data sub-structure
200 MODEL_EXPORT void setLabel(TDF_Label theLab);
202 /// Sets the object of this data
203 MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
205 myObject = theObject;
208 /// Erases all the data from the data model
209 MODEL_EXPORT virtual void erase();
211 /// Stores the state of the object to execute it later accordingly
212 MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
214 /// Returns the state of the latest execution of the feature
215 MODEL_EXPORT virtual ModelAPI_ExecState execState();
217 /// Registers error during the execution, causes the ExecutionFailed state
218 MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
220 /// Erases the error string if it is not empty
221 void eraseErrorString();
223 /// Registers error during the execution, causes the ExecutionFailed state
224 MODEL_EXPORT virtual std::string error() const;
226 /// Returns the identifier of feature-owner, unique in this document
227 MODEL_EXPORT virtual int featureId() const;
229 /// returns all objects referenced to this
230 MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
232 /// returns all references by attributes of this data
233 /// \param theRefs returned list of pairs:
234 /// id of referenced attribute and list of referenced objects
235 MODEL_EXPORT virtual void referencesToObjects(
236 std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
238 /// Copies all attributes content into theTarget data
239 MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
241 /// Returns the invalid data pointer (to avoid working with NULL shared pointers in swig)
242 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
244 /// Returns the invalid data pointer: static method
245 static std::shared_ptr<ModelAPI_Data> invalidData();
247 /// Identifier of the transaction when object (feature or result) was updated last time.
248 MODEL_EXPORT virtual int updateID();
250 /// Identifier of the transaction when object (feature or result) was updated last time.
251 /// This method is called by the updater.
252 MODEL_EXPORT virtual void setUpdateID(const int theID);
254 /// Returns true if the given object is owner of this data (needed for correct erase of object
255 /// with duplicated data)
256 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
259 /// Returns true if "is in history" custom behaviors is defined for the feature
260 MODEL_EXPORT virtual bool isInHistory();
262 /// Defines the custom "is in history" behavior
263 MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
265 /// Returns true if the object is deleted, but some data is still kept in memory
266 MODEL_EXPORT virtual bool isDeleted();
268 /// Sets true if the object is deleted, but some data is still kept in memory
269 MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
272 /// Removes a back reference (with identifier which attribute references to this object)
273 /// \param theFeature feature referenced to this
274 /// \param theAttrID identifier of the attribute that is references from theFeature to this
275 void removeBackReference(ObjectPtr theObject, std::string theAttrID);
276 /// Removes a back reference (by the attribute)
277 /// \param theAttr the referenced attribute
278 void removeBackReference(AttributePtr theAttr);
279 /// Adds a back reference (with identifier which attribute references to this object
280 /// \param theFeature feature referenced to this
281 /// \param theAttrID identifier of the attribute that is references from theFeature to this
282 /// \param theApplyConcealment applies concealment flag changes
283 void addBackReference(FeaturePtr theFeature, std::string theAttrID,
284 const bool theApplyConcealment = true);
285 /// Adds a back reference to an object
286 /// \param theObject object referenced to this
287 /// \param theAttrID identifier of the attribute that is references from theFolder to this
288 void addBackReference(ObjectPtr theObject, std::string theAttrID);
290 /// Makes the concealment flag up to date for this object-owner.
291 MODEL_EXPORT virtual void updateConcealmentFlag();
293 /// Returns true if object must be displayed in the viewer: flag is stored in the
294 /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
295 /// the original state in the current transaction.
296 MODEL_EXPORT virtual bool isDisplayed();
298 /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
300 MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
302 /// Returns \c true if theAttribute1 is going earlier than theAttribute2 in the data
303 MODEL_EXPORT virtual bool isPrecedingAttribute(const std::string& theAttribute1,
304 const std::string& theAttribute2) const;
307 /// Generic method to register back reference, used in referencing attributes.
308 /// Without concealment change, it will be done later, on synchronization.
309 #define ADD_BACK_REF(TARGET) \
310 if (TARGET.get() != NULL) { \
311 std::shared_ptr<Model_Data> aTargetData = \
312 std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
313 FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
314 if (anAttributeOwnerFeature.get()) \
315 aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
317 FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
318 if (anAttributeOwnerFolder.get()) \
319 aTargetData->addBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \
323 /// Generic method to unregister back reference, used in referencing attributes.
324 /// Without concealment change, it will be done later, on synchronization.
325 #define REMOVE_BACK_REF(TARGET) \
326 if (TARGET.get() != NULL) { \
327 std::shared_ptr<Model_Data> aTargetData = \
328 std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
329 FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
330 if (anAttOwnerFeature.get()) \
331 aTargetData->removeBackReference(anAttOwnerFeature, id()); \
333 FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
334 if (anAttributeOwnerFolder.get()) \
335 aTargetData->removeBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \