1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Entity_HeaderFile
20 #define HYDROData_Entity_HeaderFile
22 #include "HYDROData.h"
24 #include <NCollection_Sequence.hxx>
26 #include <TDF_Label.hxx>
34 class Handle(TDataStd_ReferenceList);
35 class Handle_HYDROData_Entity;
37 ///! Kind of an object in a document
38 typedef int ObjectKind;
40 const ObjectKind KIND_UNKNOWN = 0; ///! Unrecognized object
41 const ObjectKind KIND_IMAGE = 1;
42 const ObjectKind KIND_POLYLINE = 2;
43 const ObjectKind KIND_BATHYMETRY = 3;
44 const ObjectKind KIND_ALTITUDE = 4;
45 const ObjectKind KIND_IMMERSIBLE_ZONE = 5;
46 const ObjectKind KIND_RIVER = 6;
47 const ObjectKind KIND_STREAM = 7;
48 const ObjectKind KIND_CONFLUENCE = 8;
49 const ObjectKind KIND_CHANNEL = 9;
50 const ObjectKind KIND_OBSTACLE = 10;
51 const ObjectKind KIND_DIGUE = 11;
52 const ObjectKind KIND_PROFILE = 12;
53 const ObjectKind KIND_PROFILEUZ = 13;
54 const ObjectKind KIND_POLYLINEXY = 14;
55 const ObjectKind KIND_CALCULATION = 15;
56 const ObjectKind KIND_ZONE = 16;
57 const ObjectKind KIND_REGION = 17;
58 const ObjectKind KIND_VISUAL_STATE = 18;
59 const ObjectKind KIND_ARTIFICIAL_OBJECT = 19;
60 const ObjectKind KIND_NATURAL_OBJECT = 20;
61 const ObjectKind KIND_DUMMY_3D = 21;
62 const ObjectKind KIND_SHAPES_GROUP = 22;
63 const ObjectKind KIND_SPLITTED_GROUP = 23;
64 const ObjectKind KIND_STREAM_ALTITUDE = 24;
65 const ObjectKind KIND_OBSTACLE_ALTITUDE = 25;
66 const ObjectKind KIND_STRICKLER_TABLE = 26;
67 const ObjectKind KIND_LAND_COVER = 27;
68 const ObjectKind KIND_LAND_COVER_MAP = 28;
69 const ObjectKind KIND_LAST = KIND_LAND_COVER;
71 DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
73 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
75 typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
77 ///! Is Equal for HYDROData_Entity mapping
78 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
80 /**\class HYDROData_Entity
81 * \brief Generic class of any object in the data model.
83 * Interface for getting access to the object that belong to the data model.
84 * Managed by Document. Provides access to the common properties:
85 * kind of an object, name.
87 class HYDROData_Entity : public MMgt_TShared
93 * Enumeration of tags corresponding to the persistent object parameters.
97 DataTag_First = 0, ///< first tag, to reserve
98 DataTag_ZLevel, ///< z-level of object presentation
102 DEFINE_STANDARD_RTTI(HYDROData_Entity);
105 * Returns the kind of this object. Must be redefined in all objects of known type.
107 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
110 * Returns the name of this object.
112 HYDRODATA_EXPORT virtual QString GetName() const;
115 * Updates the name of this object.
117 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
120 * Returns the name of this object valid for Python script.
122 HYDRODATA_EXPORT virtual QString GetObjPyName() const;
125 * Dump object to Python script representation.
126 * Base implementation returns empty list,
127 * You should reimplement this function in your derived class if it
128 * has Python API and can be imported/exported from/to Python script.
130 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
133 * Updates object state. Base implementation dose nothing.
135 HYDRODATA_EXPORT virtual void Update();
137 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
140 * Checks that object has 2D presentation. Base implementation returns false.
142 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
145 * Show object at the top of other model objects.
147 HYDRODATA_EXPORT virtual void Show();
151 * Returns data of object wrapped to QVariant.
152 * Base implementation returns null value.
154 HYDRODATA_EXPORT virtual QVariant GetDataVariant();
158 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
159 * \param theFlag is true for objects that must be updated, false for up-to-date
161 HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
164 * Returns the "MustBeUpdated" flag: is object data must be updated or not
165 * \returns false if object is up to date
167 HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
170 * Returns flag indicating that object is updateble or not.
172 HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
176 * Checks is object exists in the data structure.
177 * \returns true is object is not exists in the data model
179 HYDRODATA_EXPORT bool IsRemoved() const;
182 * Removes object and it child sub-objects from the data structure.
184 HYDRODATA_EXPORT virtual void Remove();
187 * Returns flag indicating that object can be removed or not.
188 * Reimplement this method in class which can't be removed
189 * separately with it parent object.
190 * Base implementaiton returns always TRUE.
192 HYDRODATA_EXPORT virtual bool CanRemove();
195 * Copies all properties of this to the destinated object.
196 * Objects must be the same type.
197 * \param theDestination initialized object (from any document) - target of copying
199 HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination,
200 bool isGenerateNewName ) const;
203 * Returns the label of this object.
205 HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
209 * Returns father object. For object created under root document label
210 * this method always return NULL object.
212 HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
216 * Returns the list of all reference objects of this object.
217 * Base implementation always return empty list.
219 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
223 * Returns the z-level for object presentation, -1 if no z-level.
225 HYDRODATA_EXPORT virtual Standard_Boolean GetZLevel( Standard_Integer& theLevel ) const;
228 * Set the z-level for object presentation.
230 HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
233 * Remove the z-level of object presentation.
235 HYDRODATA_EXPORT virtual void RemoveZLevel();
238 Find the Python object in the document by the object name.
239 @param theTreatedObjects the map of treated objects
240 @param theScript the script
242 void findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
243 QStringList& theScript ) const;
246 * Internal method that used to store the color attribute
247 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
248 * \param theColor color to save
250 HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
253 * Internal method that used to retreive the color attribute
254 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
255 * \param theDefColor default color to return if attribute has not been set before
257 HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
261 friend class HYDROData_Iterator;
264 * Creates new object in the internal data structure. Use higher level objects
265 * to create objects with real content.
267 HYDRODATA_EXPORT HYDROData_Entity();
270 * Destructs properties of the object and object itself, removes it from the document.
272 virtual HYDRODATA_EXPORT ~HYDROData_Entity();
275 * Put the object to the label of the document.
276 * \param theLabel new label of the object
278 HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
281 * Internal method that used to store the byte array attribute
282 * \param theTag tag of a label to store attribute (for 0 this is myLab)
283 * \param theData pointer to bytes array
284 * \param theLen number of bytes in byte array that must be stored
286 void SaveByteArray(const int theTag, const char* theData, const int theLen);
289 * Internal method that used to retreive the content of byte array attribute
290 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
291 * \param theLen number of bytes in byte array
292 * \returns pointer to the internal data structure wit harray content,
293 * or NULL if array size is zero
295 const char* ByteArray(const int theTag, int& theLen) const;
298 * Internal method that used to store the reference object label attribute
299 * \param theObj pointer to reference object
300 * \param theTag tag of a label to store attribute (for 0 this is myLab)
302 int NbReferenceObjects( const int theTag = 0 ) const;
305 * Internal method that used to check object for entry into the reference list
306 * \param theObj pointer to reference object
307 * \param theTag tag of a label to store attribute (for 0 this is myLab)
309 bool HasReference( const Handle_HYDROData_Entity& theObj,
310 const int theTag = 0 ) const;
313 * Internal method that used to store the reference object label attribute
314 * \param theObj pointer to reference object
315 * \param theTag tag of a label to store attribute (for 0 this is myLab)
317 void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
318 const int theTag = 0 );
321 * Internal method that used to store the reference object label attribute
322 * \param theObj pointer to reference object
323 * \param theTag tag of a label to store attribute (for 0 this is myLab)
324 * \param theIndex index in the list of references
325 - if more that len then just append it to the end of list
326 - if less than zero then prepend to the list
327 - indexing starts from 0
329 void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
330 const int theTag = 0,
331 const int theIndex = 0 );
334 * Internal method that used to store the reference object label attribute
335 * \param theObj pointer to reference object
336 * \param theTag tag of a label to store attribute (for 0 this is myLab)
337 * \param theBeforeIndex index in the list of references
338 - if more that len then just append it to the end of list
339 - if less than zero then prepend to the list
340 - indexing starts from 0
342 void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
343 const int theTag = 0,
344 const int theBeforeIndex = 0 );
347 * Internal method that used to store the reference object label attribute
348 * \param theObjects sequence with pointers to reference objects
349 * \param theTag tag of a label to store attribute (for 0 this is myLab)
351 void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
352 const int theTag = 0 );
355 * Internal method that used to retreive the reference object(s) attribute
356 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
357 * \param theIndex index in the list of references
358 * - indexing starts from 0
359 * \returns pointer to reference object or NULL if label is not set
361 Handle_HYDROData_Entity GetReferenceObject( const int theTag = 0,
362 const int theIndex = 0 ) const;
364 HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
367 * Internal method that used to remove the reference object attribute
368 * \param theRefLabel reference object label to remove
369 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
371 void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
374 * Internal method that used to remove the reference object attribute
375 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
376 * \param theIndex index in the list of references
377 * - indexing starts from 0
379 void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
382 * Internal method that used to clear list of the reference objects attribute
383 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
385 void ClearReferenceObjects( const int theTag = 0 );
390 * Dump the initial object creation to a Python script.
391 * You should call it from DumpToPython implementation before
392 * dumping fields of the object.
394 HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
397 * Returns an object type name as a string for dumping to Python.
399 QString getPyTypeID() const;
401 void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
402 QStringList& theScript,
403 const Handle(HYDROData_Entity)& theRefObject,
404 const QString& theMethod ) const;
406 bool checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
407 QStringList& theScript,
408 const Handle(HYDROData_Entity)& theRefObject ) const;
410 void setPythonObjectColor( QStringList& theScript,
411 const QColor& theColor,
412 const QColor& theDefaultColor,
413 const QString& theMethod ) const;
417 Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,
418 const bool theIsCreate ) const;
422 /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
423 TDF_Label myLab; ///< label of this object