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_LAST = KIND_STRICKLER_TABLE;
69 DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
71 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
73 typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
75 ///! Is Equal for HYDROData_Entity mapping
76 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
78 /**\class HYDROData_Entity
79 * \brief Generic class of any object in the data model.
81 * Interface for getting access to the object that belong to the data model.
82 * Managed by Document. Provides access to the common properties:
83 * kind of an object, name.
85 class HYDROData_Entity : public MMgt_TShared
91 * Enumeration of tags corresponding to the persistent object parameters.
95 DataTag_First = 0, ///< first tag, to reserve
96 DataTag_ZLevel, ///< z-level of object presentation
100 DEFINE_STANDARD_RTTI(HYDROData_Entity);
103 * Returns the kind of this object. Must be redefined in all objects of known type.
105 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
108 * Returns the name of this object.
110 HYDRODATA_EXPORT virtual QString GetName() const;
113 * Updates the name of this object.
115 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
118 * Returns the name of this object valid for Python script.
120 HYDRODATA_EXPORT virtual QString GetObjPyName() const;
123 * Dump object to Python script representation.
124 * Base implementation returns empty list,
125 * You should reimplement this function in your derived class if it
126 * has Python API and can be imported/exported from/to Python script.
128 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
131 * Updates object state. Base implementation dose nothing.
133 HYDRODATA_EXPORT virtual void Update();
135 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
138 * Checks that object has 2D presentation. Base implementation returns false.
140 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
143 * Show object at the top of other model objects.
145 HYDRODATA_EXPORT virtual void Show();
149 * Returns data of object wrapped to QVariant.
150 * Base implementation returns null value.
152 HYDRODATA_EXPORT virtual QVariant GetDataVariant();
156 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
157 * \param theFlag is true for objects that must be updated, false for up-to-date
159 HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
162 * Returns the "MustBeUpdated" flag: is object data must be updated or not
163 * \returns false if object is up to date
165 HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
168 * Returns flag indicating that object is updateble or not.
170 HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
174 * Checks is object exists in the data structure.
175 * \returns true is object is not exists in the data model
177 HYDRODATA_EXPORT bool IsRemoved() const;
180 * Removes object and it child sub-objects from the data structure.
182 HYDRODATA_EXPORT virtual void Remove();
185 * Returns flag indicating that object can be removed or not.
186 * Reimplement this method in class which can't be removed
187 * separately with it parent object.
188 * Base implementaiton returns always TRUE.
190 HYDRODATA_EXPORT virtual bool CanRemove();
193 * Copies all properties of this to the destinated object.
194 * Objects must be the same type.
195 * \param theDestination initialized object (from any document) - target of copying
197 HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination ) const;
200 * Returns the label of this object.
202 HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
206 * Returns father object. For object created under root document label
207 * this method always return NULL object.
209 HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
213 * Returns the list of all reference objects of this object.
214 * Base implementation always return empty list.
216 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
220 * Returns the z-level for object presentation, -1 if no z-level.
222 HYDRODATA_EXPORT virtual Standard_Boolean GetZLevel( Standard_Integer& theLevel ) const;
225 * Set the z-level for object presentation.
227 HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
230 * Remove the z-level of object presentation.
232 HYDRODATA_EXPORT virtual void RemoveZLevel();
235 Find the Python object in the document by the object name.
236 @param theTreatedObjects the map of treated objects
237 @param theScript the script
239 void findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
240 QStringList& theScript ) const;
243 * Internal method that used to store the color attribute
244 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
245 * \param theColor color to save
247 HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
250 * Internal method that used to retreive the color attribute
251 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
252 * \param theDefColor default color to return if attribute has not been set before
254 HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
258 friend class HYDROData_Iterator;
261 * Creates new object in the internal data structure. Use higher level objects
262 * to create objects with real content.
264 HYDRODATA_EXPORT HYDROData_Entity();
267 * Destructs properties of the object and object itself, removes it from the document.
269 virtual HYDRODATA_EXPORT ~HYDROData_Entity();
272 * Put the object to the label of the document.
273 * \param theLabel new label of the object
275 HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
278 * Internal method that used to store the byte array attribute
279 * \param theTag tag of a label to store attribute (for 0 this is myLab)
280 * \param theData pointer to bytes array
281 * \param theLen number of bytes in byte array that must be stored
283 void SaveByteArray(const int theTag, const char* theData, const int theLen);
286 * Internal method that used to retreive the content of byte array attribute
287 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
288 * \param theLen number of bytes in byte array
289 * \returns pointer to the internal data structure wit harray content,
290 * or NULL if array size is zero
292 const char* ByteArray(const int theTag, int& theLen) const;
295 * Internal method that used to store the reference object label attribute
296 * \param theObj pointer to reference object
297 * \param theTag tag of a label to store attribute (for 0 this is myLab)
299 int NbReferenceObjects( const int theTag = 0 ) const;
302 * Internal method that used to check object for entry into the reference list
303 * \param theObj pointer to reference object
304 * \param theTag tag of a label to store attribute (for 0 this is myLab)
306 bool HasReference( const Handle_HYDROData_Entity& theObj,
307 const int theTag = 0 ) const;
310 * Internal method that used to store the reference object label attribute
311 * \param theObj pointer to reference object
312 * \param theTag tag of a label to store attribute (for 0 this is myLab)
314 void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
315 const int theTag = 0 );
318 * Internal method that used to store the reference object label attribute
319 * \param theObj pointer to reference object
320 * \param theTag tag of a label to store attribute (for 0 this is myLab)
321 * \param theIndex index in the list of references
322 - if more that len then just append it to the end of list
323 - if less than zero then prepend to the list
324 - indexing starts from 0
326 void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
327 const int theTag = 0,
328 const int theIndex = 0 );
331 * Internal method that used to store the reference object label attribute
332 * \param theObj pointer to reference object
333 * \param theTag tag of a label to store attribute (for 0 this is myLab)
334 * \param theBeforeIndex index in the list of references
335 - if more that len then just append it to the end of list
336 - if less than zero then prepend to the list
337 - indexing starts from 0
339 void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
340 const int theTag = 0,
341 const int theBeforeIndex = 0 );
344 * Internal method that used to store the reference object label attribute
345 * \param theObjects sequence with pointers to reference objects
346 * \param theTag tag of a label to store attribute (for 0 this is myLab)
348 void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
349 const int theTag = 0 );
352 * Internal method that used to retreive the reference object(s) attribute
353 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
354 * \param theIndex index in the list of references
355 * - indexing starts from 0
356 * \returns pointer to reference object or NULL if label is not set
358 Handle_HYDROData_Entity GetReferenceObject( const int theTag = 0,
359 const int theIndex = 0 ) const;
361 HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
364 * Internal method that used to remove the reference object attribute
365 * \param theRefLabel reference object label to remove
366 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
368 void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
371 * Internal method that used to remove the reference object attribute
372 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
373 * \param theIndex index in the list of references
374 * - indexing starts from 0
376 void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
379 * Internal method that used to clear list of the reference objects attribute
380 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
382 void ClearReferenceObjects( const int theTag = 0 );
387 * Dump the initial object creation to a Python script.
388 * You should call it from DumpToPython implementation before
389 * dumping fields of the object.
391 HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
394 * Returns an object type name as a string for dumping to Python.
396 QString getPyTypeID() const;
398 void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
399 QStringList& theScript,
400 const Handle(HYDROData_Entity)& theRefObject,
401 const QString& theMethod ) const;
403 bool checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
404 QStringList& theScript,
405 const Handle(HYDROData_Entity)& theRefObject ) const;
407 void setPythonObjectColor( QStringList& theScript,
408 const QColor& theColor,
409 const QColor& theDefaultColor,
410 const QString& theMethod ) const;
414 Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,
415 const bool theIsCreate ) const;
419 /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
420 TDF_Label myLab; ///< label of this object