2 #ifndef HYDROData_Entity_HeaderFile
3 #define HYDROData_Entity_HeaderFile
7 #include <NCollection_Sequence.hxx>
9 #include <TDF_Label.hxx>
17 class Handle(TDataStd_ReferenceList);
18 class Handle_HYDROData_Entity;
20 ///! Kind of an object in a document
21 typedef int ObjectKind;
23 const ObjectKind KIND_UNKNOWN = 0; ///! Unrecognized object
24 const ObjectKind KIND_IMAGE = 1;
25 const ObjectKind KIND_POLYLINE = 2;
26 const ObjectKind KIND_BATHYMETRY = 3;
27 const ObjectKind KIND_ALTITUDE = 4;
28 const ObjectKind KIND_IMMERSIBLE_ZONE = 5;
29 const ObjectKind KIND_RIVER = 6;
30 const ObjectKind KIND_STREAM = 7;
31 const ObjectKind KIND_CONFLUENCE = 8;
32 const ObjectKind KIND_CHANNEL = 9;
33 const ObjectKind KIND_OBSTACLE = 10;
34 const ObjectKind KIND_DIGUE = 11;
35 const ObjectKind KIND_PROFILE = 12;
36 const ObjectKind KIND_PROFILEUZ = 13;
37 const ObjectKind KIND_POLYLINEXY = 14;
38 const ObjectKind KIND_CALCULATION = 15;
39 const ObjectKind KIND_ZONE = 16;
40 const ObjectKind KIND_REGION = 17;
41 const ObjectKind KIND_VISUAL_STATE = 18;
42 const ObjectKind KIND_LAST = KIND_VISUAL_STATE;
44 DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
46 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
48 typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
51 /**\class HYDROData_Entity
52 * \brief Generic class of any object in the data model.
54 * Interface for getting access to the object that belong to the data model.
55 * Managed by Document. Provides access to the common properties:
56 * kind of an object, name.
58 class HYDROData_Entity : public MMgt_TShared
64 * Enumeration of tags corresponding to the persistent object parameters.
68 DataTag_First = 0 ///< first tag, to reserve
73 DEFINE_STANDARD_RTTI(HYDROData_Entity);
76 * Returns the kind of this object. Must be redefined in all objects of known type.
78 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
81 * Returns the name of this object.
83 HYDRODATA_EXPORT QString GetName() const;
86 * Updates the name of this object.
88 HYDRODATA_EXPORT void SetName(const QString& theName);
91 * Dump object to Python script representation.
92 * Base implementation returns empty list,
93 * You should reimplement this function in your derived class if it
94 * has Python API and can be imported/exported from/to Python script.
96 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
99 * Updates object state.
100 * Base implementation dose nothing.
101 * \param theIsForce force reupdating of data object
103 HYDRODATA_EXPORT virtual void Update( const bool theIsForce = true );
106 * Returns data of object wrapped to QVariant.
107 * Base implementation returns null value.
109 HYDRODATA_EXPORT virtual QVariant GetDataVariant();
112 * Checks is object exists in the data structure.
113 * \returns true is object is not exists in the data model
115 HYDRODATA_EXPORT bool IsRemoved() const;
118 * Removes object and it child sub-objects from the data structure.
120 HYDRODATA_EXPORT virtual void Remove();
123 * Returns unique integer identifier of the object (may be used for ordering of objects)
125 HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
128 * Copies all properties of this to the destinated object.
129 * Objects must be the same type.
130 * \param theDestination initialized object (from any document) - target of copying
132 HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Entity theDestination) const;
135 * Returns the label of this object.
137 HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
140 * Returns father object. For object created under root document label
141 * this method always return NULL object.
143 HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
147 friend class HYDROData_Iterator;
150 * Creates new object in the internal data structure. Use higher level objects
151 * to create objects with real content.
153 HYDRODATA_EXPORT HYDROData_Entity();
156 * Destructs properties of the object and object itself, removes it from the document.
158 virtual HYDRODATA_EXPORT ~HYDROData_Entity();
161 * Put the object to the label of the document.
162 * \param theLabel new label of the object
164 HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
167 * Internal method that used to store the byte array attribute
168 * \param theTag tag of a label to store attribute (for 0 this is myLab)
169 * \param theData pointer to bytes array
170 * \param theLen number of bytes in byte array that must be stored
172 void SaveByteArray(const int theTag, const char* theData, const int theLen);
175 * Internal method that used to retreive the content of byte array attribute
176 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
177 * \param theLen number of bytes in byte array
178 * \returns pointer to the internal data structure wit harray content,
179 * or NULL if array size is zero
181 const char* ByteArray(const int theTag, int& theLen) const;
184 * Internal method that used to store the reference object label attribute
185 * \param theObj pointer to reference object
186 * \param theTag tag of a label to store attribute (for 0 this is myLab)
188 int NbReferenceObjects( const int theTag = 0 ) const;
191 * Internal method that used to check object for entry into the reference list
192 * \param theObj pointer to reference object
193 * \param theTag tag of a label to store attribute (for 0 this is myLab)
195 bool HasReference( const Handle_HYDROData_Entity& theObj,
196 const int theTag = 0 ) const;
199 * Internal method that used to store the reference object label attribute
200 * \param theObj pointer to reference object
201 * \param theTag tag of a label to store attribute (for 0 this is myLab)
203 void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
204 const int theTag = 0 );
207 * Internal method that used to store the reference object label attribute
208 * \param theObj pointer to reference object
209 * \param theTag tag of a label to store attribute (for 0 this is myLab)
210 * \param theIndex index in the list of references
211 - if more that len then just append it to the end of list
212 - if less than zero then prepend to the list
213 - indexing starts from 0
215 void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
216 const int theTag = 0,
217 const int theIndex = 0 );
220 * Internal method that used to store the reference object label attribute
221 * \param theObj pointer to reference object
222 * \param theTag tag of a label to store attribute (for 0 this is myLab)
223 * \param theBeforeIndex index in the list of references
224 - if more that len then just append it to the end of list
225 - if less than zero then prepend to the list
226 - indexing starts from 0
228 void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
229 const int theTag = 0,
230 const int theBeforeIndex = 0 );
233 * Internal method that used to store the reference object label attribute
234 * \param theObjects sequence with pointers to reference objects
235 * \param theTag tag of a label to store attribute (for 0 this is myLab)
237 void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
238 const int theTag = 0 );
241 * Internal method that used to retreive the reference object(s) attribute
242 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
243 * \param theIndex index in the list of references
244 * - indexing starts from 0
245 * \returns pointer to reference object or NULL if label is not set
247 Handle_HYDROData_Entity GetReferenceObject( const int theTag = 0,
248 const int theIndex = 0 ) const;
250 HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
253 * Internal method that used to remove the reference object attribute
254 * \param theRefLabel reference object label to remove
255 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
257 void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
260 * Internal method that used to remove the reference object attribute
261 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
262 * \param theIndex index in the list of references
263 * - indexing starts from 0
265 void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
268 * Internal method that used to clear list of the reference objects attribute
269 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
271 void ClearReferenceObjects( const int theTag = 0 );
274 * Internal method that used to store the color attribute
275 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
276 * \param theColor color to save
278 void SetColor( const QColor& theColor, const int theTag = 0 );
281 * Internal method that used to retreive the color attribute
282 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
283 * \param theDefColor default color to return if attribute has not been set before
285 QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
290 void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
291 QStringList& theScript,
292 const Handle(HYDROData_Entity)& theRefObject,
293 const QString& theMethod ) const;
296 Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,
297 const bool theIsCreate ) const;
301 /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
302 TDF_Label myLab; ///< label of this object
305 ///! Is Equal for HYDROData_Entity mapping
306 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);