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 class MapOfTreatedObjects : public QMap<QString,Handle(Standard_Transient)>
77 class HYDRODATA_EXPORT HYDROData_SequenceOfObjects : public NCollection_Sequence<Handle_HYDROData_Entity>
80 HYDROData_SequenceOfObjects();
81 HYDROData_SequenceOfObjects( const HYDROData_SequenceOfObjects& );
82 HYDROData_SequenceOfObjects( const NCollection_Sequence<Handle_HYDROData_Entity>& );
85 ///! Is Equal for HYDROData_Entity mapping
86 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
88 /**\class HYDROData_Entity
89 * \brief Generic class of any object in the data model.
91 * Interface for getting access to the object that belong to the data model.
92 * Managed by Document. Provides access to the common properties:
93 * kind of an object, name.
95 class HYDROData_Entity : public MMgt_TShared
101 * Enumeration of tags corresponding to the persistent object parameters.
105 DataTag_First = 0, ///< first tag, to reserve
106 DataTag_ZLevel, ///< z-level of object presentation
110 DEFINE_STANDARD_RTTI(HYDROData_Entity);
113 * Returns the kind of this object. Must be redefined in all objects of known type.
115 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
118 * Returns the name of this object.
120 HYDRODATA_EXPORT virtual QString GetName() const;
123 * Updates the name of this object.
125 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
128 * Returns the name of this object valid for Python script.
130 HYDRODATA_EXPORT virtual QString GetObjPyName() const;
133 * Dump object to Python script representation.
134 * Base implementation returns empty list,
135 * You should reimplement this function in your derived class if it
136 * has Python API and can be imported/exported from/to Python script.
138 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
141 * Updates object state. Base implementation dose nothing.
143 HYDRODATA_EXPORT virtual void Update();
145 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
148 * Checks that object has 2D presentation. Base implementation returns false.
150 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
153 * Show object at the top of other model objects.
155 HYDRODATA_EXPORT virtual void Show();
159 * Returns data of object wrapped to QVariant.
160 * Base implementation returns null value.
162 HYDRODATA_EXPORT virtual QVariant GetDataVariant();
166 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
167 * \param theFlag is true for objects that must be updated, false for up-to-date
169 HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
172 * Returns the "MustBeUpdated" flag: is object data must be updated or not
173 * \returns false if object is up to date
175 HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
178 * Returns flag indicating that object is updateble or not.
180 HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
184 * Checks is object exists in the data structure.
185 * \returns true is object is not exists in the data model
187 HYDRODATA_EXPORT bool IsRemoved() const;
190 * Removes object and it child sub-objects from the data structure.
192 HYDRODATA_EXPORT virtual void Remove();
195 * Returns flag indicating that object can be removed or not.
196 * Reimplement this method in class which can't be removed
197 * separately with it parent object.
198 * Base implementaiton returns always TRUE.
200 HYDRODATA_EXPORT virtual bool CanRemove();
203 * Copies all properties of this to the destinated object.
204 * Objects must be the same type.
205 * \param theDestination initialized object (from any document) - target of copying
207 HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination,
208 bool isGenerateNewName ) const;
211 * Returns the label of this object.
213 HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
217 * Returns father object. For object created under root document label
218 * this method always return NULL object.
220 HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
224 * Returns the list of all reference objects of this object.
225 * Base implementation always return empty list.
227 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
231 * Returns the z-level for object presentation, -1 if no z-level.
233 HYDRODATA_EXPORT virtual Standard_Boolean GetZLevel( Standard_Integer& theLevel ) const;
236 * Set the z-level for object presentation.
238 HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
241 * Remove the z-level of object presentation.
243 HYDRODATA_EXPORT virtual void RemoveZLevel();
246 Find the Python object in the document by the object name.
247 @param theTreatedObjects the map of treated objects
248 @param theScript the script
250 void findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
251 QStringList& theScript ) const;
254 * Internal method that used to store the color attribute
255 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
256 * \param theColor color to save
258 HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
261 * Internal method that used to retreive the color attribute
262 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
263 * \param theDefColor default color to return if attribute has not been set before
265 HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
269 friend class HYDROData_Iterator;
272 * Creates new object in the internal data structure. Use higher level objects
273 * to create objects with real content.
275 HYDRODATA_EXPORT HYDROData_Entity();
278 * Destructs properties of the object and object itself, removes it from the document.
280 virtual HYDRODATA_EXPORT ~HYDROData_Entity();
283 * Put the object to the label of the document.
284 * \param theLabel new label of the object
286 HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
289 * Internal method that used to store the byte array attribute
290 * \param theTag tag of a label to store attribute (for 0 this is myLab)
291 * \param theData pointer to bytes array
292 * \param theLen number of bytes in byte array that must be stored
294 void SaveByteArray(const int theTag, const char* theData, const int theLen);
297 * Internal method that used to retreive the content of byte array attribute
298 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
299 * \param theLen number of bytes in byte array
300 * \returns pointer to the internal data structure wit harray content,
301 * or NULL if array size is zero
303 const char* ByteArray(const int theTag, int& theLen) const;
306 * Internal method that used to store the reference object label attribute
307 * \param theObj pointer to reference object
308 * \param theTag tag of a label to store attribute (for 0 this is myLab)
310 int NbReferenceObjects( const int theTag = 0 ) const;
313 * Internal method that used to check object for entry into the reference list
314 * \param theObj pointer to reference object
315 * \param theTag tag of a label to store attribute (for 0 this is myLab)
317 bool HasReference( const Handle_HYDROData_Entity& theObj,
318 const int theTag = 0 ) const;
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)
325 void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
326 const int theTag = 0 );
329 * Internal method that used to store the reference object label attribute
330 * \param theObj pointer to reference object
331 * \param theTag tag of a label to store attribute (for 0 this is myLab)
332 * \param theIndex index in the list of references
333 - if more that len then just append it to the end of list
334 - if less than zero then prepend to the list
335 - indexing starts from 0
337 void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
338 const int theTag = 0,
339 const int theIndex = 0 );
342 * Internal method that used to store the reference object label attribute
343 * \param theObj pointer to reference object
344 * \param theTag tag of a label to store attribute (for 0 this is myLab)
345 * \param theBeforeIndex index in the list of references
346 - if more that len then just append it to the end of list
347 - if less than zero then prepend to the list
348 - indexing starts from 0
350 void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
351 const int theTag = 0,
352 const int theBeforeIndex = 0 );
355 * Internal method that used to store the reference object label attribute
356 * \param theObjects sequence with pointers to reference objects
357 * \param theTag tag of a label to store attribute (for 0 this is myLab)
359 void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
360 const int theTag = 0 );
363 * Internal method that used to retreive the reference object(s) attribute
364 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
365 * \param theIndex index in the list of references
366 * - indexing starts from 0
367 * \returns pointer to reference object or NULL if label is not set
369 Handle_HYDROData_Entity GetReferenceObject( const int theTag = 0,
370 const int theIndex = 0 ) const;
372 HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
375 * Internal method that used to remove the reference object attribute
376 * \param theRefLabel reference object label to remove
377 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
379 void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
382 * Internal method that used to remove the reference object attribute
383 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
384 * \param theIndex index in the list of references
385 * - indexing starts from 0
387 void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
390 * Internal method that used to clear list of the reference objects attribute
391 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
393 void ClearReferenceObjects( const int theTag = 0 );
398 * Dump the initial object creation to a Python script.
399 * You should call it from DumpToPython implementation before
400 * dumping fields of the object.
402 HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
405 * Returns an object type name as a string for dumping to Python.
407 QString getPyTypeID() const;
409 void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
410 QStringList& theScript,
411 const Handle(HYDROData_Entity)& theRefObject,
412 const QString& theMethod ) const;
414 bool checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
415 QStringList& theScript,
416 const Handle(HYDROData_Entity)& theRefObject ) const;
418 void setPythonObjectColor( QStringList& theScript,
419 const QColor& theColor,
420 const QColor& theDefaultColor,
421 const QString& theMethod ) const;
425 Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,
426 const bool theIsCreate ) const;
430 /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
431 TDF_Label myLab; ///< label of this object