]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Entity.h
Salome HOME
Merge branch 'BR_v14_rc' into BR_SINUSX_FORMAT
[modules/hydro.git] / src / HYDROData / HYDROData_Entity.h
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.
6 //
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.
11 //
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
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #ifndef HYDROData_Entity_HeaderFile
20 #define HYDROData_Entity_HeaderFile
21
22 #include "HYDROData.h"
23
24 #include <NCollection_Sequence.hxx>
25
26 #include <TDF_Label.hxx>
27
28 #include <QMap>
29
30 class QColor;
31 class QString;
32 class QVariant;
33 class QStringList;
34 class Handle(TDataStd_ReferenceList);
35 class Handle_HYDROData_Entity;
36
37 ///! Kind of an object in a document
38 typedef int ObjectKind;
39
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_LAST              = KIND_LAND_COVER;
69
70 DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
71
72 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
73
74 typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
75
76 ///! Is Equal for HYDROData_Entity mapping
77 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
78
79 /**\class HYDROData_Entity
80  * \brief Generic class of any object in the data model.
81  *
82  * Interface for getting access to the object that belong to the data model.
83  * Managed by Document. Provides access to the common properties: 
84  * kind of an object, name.
85  */
86 class HYDROData_Entity : public MMgt_TShared
87 {
88
89 protected:
90
91   /**
92    * Enumeration of tags corresponding to the persistent object parameters.
93    */
94   enum DataTag
95   {
96     DataTag_First  = 0,     ///< first tag, to reserve
97     DataTag_ZLevel,         ///< z-level of object presentation
98   };
99
100 public:
101   DEFINE_STANDARD_RTTI(HYDROData_Entity);
102
103   /**
104    * Returns the kind of this object. Must be redefined in all objects of known type.
105    */
106   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
107
108   /**
109    * Returns the name of this object.
110    */
111   HYDRODATA_EXPORT virtual QString GetName() const;
112
113   /**
114    * Updates the name of this object.
115    */
116   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
117
118   /**
119    * Returns the name of this object valid for Python script.
120    */
121   HYDRODATA_EXPORT virtual QString GetObjPyName() const;
122
123   /**
124    * Dump object to Python script representation.
125    * Base implementation returns empty list,
126    * You should reimplement this function in your derived class if it
127    * has Python API and can be imported/exported from/to Python script.
128    */
129   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
130
131   /**
132    * Updates object state. Base implementation dose nothing.
133    */
134   HYDRODATA_EXPORT virtual void Update();
135
136   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
137
138   /**
139    * Checks that object has 2D presentation. Base implementation returns false.
140    */
141   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
142
143   /**
144    * Show object at the top of other model objects.
145    */
146   HYDRODATA_EXPORT virtual void Show();
147
148
149   /**
150    * Returns data of object wrapped to QVariant.
151    * Base implementation returns null value.
152    */
153   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
154
155
156   /**
157    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
158    * \param theFlag is true for objects that must be updated, false for up-to-date
159    */
160   HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
161
162   /**
163    * Returns the "MustBeUpdated" flag: is object data must be updated or not
164    * \returns false if object is up to date
165    */
166   HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
167
168   /**
169    * Returns flag indicating that object is updateble or not.
170    */
171   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
172
173
174   /**
175    * Checks is object exists in the data structure.
176    * \returns true is object is not exists in the data model
177    */
178   HYDRODATA_EXPORT bool IsRemoved() const;
179
180   /**
181    * Removes object and it child sub-objects from the data structure.
182    */
183   HYDRODATA_EXPORT virtual void Remove();
184
185   /**
186    * Returns flag indicating that object can be removed or not.
187    * Reimplement this method in class which can't be removed 
188    * separately with it parent object.
189    * Base implementaiton returns always TRUE.
190    */
191   HYDRODATA_EXPORT virtual bool CanRemove();
192
193   /**
194    * Copies all properties of this to the destinated object.
195    * Objects must be the same type.
196    * \param theDestination initialized object (from any document) - target of copying
197    */
198   HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination ) const;
199
200   /**
201    * Returns the label of this object.
202    */
203   HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
204
205
206   /**
207    * Returns father object. For object created under root document label
208    * this method always return NULL object.
209    */
210   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
211
212
213   /**
214    * Returns the list of all reference objects of this object.
215    * Base implementation always return empty list.
216    */
217   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
218
219
220   /**
221    * Returns the z-level for object presentation, -1 if no z-level.
222    */
223   HYDRODATA_EXPORT virtual Standard_Boolean GetZLevel( Standard_Integer& theLevel ) const;
224
225   /**
226    * Set the z-level for object presentation.
227    */
228   HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
229
230   /**
231    * Remove the z-level of object presentation.
232    */
233   HYDRODATA_EXPORT virtual void RemoveZLevel();
234
235   /**
236     Find the Python object in the document by the object name.
237     @param theTreatedObjects the map of treated objects
238     @param theScript the script
239   */
240   void findPythonReferenceObject( MapOfTreatedObjects&            theTreatedObjects,
241                                   QStringList&                    theScript ) const;
242
243   /**
244    * Internal method that used to store the color attribute
245    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
246    * \param theColor color to save
247    */
248   HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
249
250   /**
251    * Internal method that used to retreive the color attribute
252    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
253    * \param theDefColor default color to return if attribute has not been set before
254    */
255   HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
256  
257 protected:
258
259   friend class HYDROData_Iterator;
260
261   /**
262    * Creates new object in the internal data structure. Use higher level objects 
263    * to create objects with real content.
264    */
265   HYDRODATA_EXPORT HYDROData_Entity();
266
267   /**
268    * Destructs properties of the object and object itself, removes it from the document.
269    */
270   virtual HYDRODATA_EXPORT ~HYDROData_Entity();
271
272   /**
273    * Put the object to the label of the document.
274    * \param theLabel new label of the object
275    */
276   HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
277
278   /**
279    * Internal method that used to store the byte array attribute
280    * \param theTag tag of a label to store attribute (for 0 this is myLab)
281    * \param theData pointer to bytes array
282    * \param theLen number of bytes in byte array that must be stored
283    */
284   void SaveByteArray(const int theTag, const char* theData, const int theLen);
285
286   /**
287    * Internal method that used to retreive the content of byte array attribute
288    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
289    * \param theLen number of bytes in byte array
290    * \returns pointer to the internal data structure wit harray content, 
291    *          or NULL if array size is zero
292    */
293   const char* ByteArray(const int theTag, int& theLen) const;
294
295   /**
296    * Internal method that used to store the reference object label attribute
297    * \param theObj pointer to reference object
298    * \param theTag tag of a label to store attribute (for 0 this is myLab)
299    */
300   int NbReferenceObjects( const int theTag = 0 ) const;
301
302   /**
303    * Internal method that used to check object for entry into the reference list
304    * \param theObj pointer to reference object
305    * \param theTag tag of a label to store attribute (for 0 this is myLab)
306    */
307   bool HasReference( const Handle_HYDROData_Entity& theObj,
308                      const int                      theTag = 0 ) const;
309
310   /**
311    * Internal method that used to store the reference object label attribute
312    * \param theObj pointer to reference object
313    * \param theTag tag of a label to store attribute (for 0 this is myLab)
314    */
315   void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
316                            const int                      theTag = 0 );
317
318   /**
319    * Internal method that used to store the reference object label attribute
320    * \param theObj pointer to reference object
321    * \param theTag tag of a label to store attribute (for 0 this is myLab)
322    * \param theIndex index in the list of references 
323              - if more that len then just append it to the end of list
324              - if less than zero then prepend to the list
325              - indexing starts from 0
326    */
327   void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
328                            const int                      theTag = 0,
329                            const int                      theIndex = 0 );
330
331   /**
332    * Internal method that used to store the reference object label attribute
333    * \param theObj pointer to reference object
334    * \param theTag tag of a label to store attribute (for 0 this is myLab)
335    * \param theBeforeIndex index in the list of references 
336              - if more that len then just append it to the end of list
337              - if less than zero then prepend to the list
338              - indexing starts from 0
339    */
340   void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
341                               const int                      theTag = 0,
342                               const int                      theBeforeIndex = 0 );
343
344   /**
345    * Internal method that used to store the reference object label attribute
346    * \param theObjects sequence with pointers to reference objects
347    * \param theTag tag of a label to store attribute (for 0 this is myLab)
348    */
349   void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
350                             const int                          theTag = 0 );
351
352   /**
353    * Internal method that used to retreive the reference object(s) attribute
354    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
355    * \param theIndex index in the list of references 
356    *        - indexing starts from 0
357    * \returns pointer to reference object or NULL if label is not set
358    */
359   Handle_HYDROData_Entity GetReferenceObject( const int theTag   = 0,
360                                               const int theIndex = 0 ) const;
361
362   HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
363
364   /**
365    * Internal method that used to remove the reference object attribute
366    * \param theRefLabel reference object label to remove
367    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
368    */
369   void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
370
371   /**
372    * Internal method that used to remove the reference object attribute
373    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
374    * \param theIndex index in the list of references 
375    *        - indexing starts from 0
376    */
377   void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
378
379   /**
380    * Internal method that used to clear list of the reference objects attribute
381    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
382    */
383   void ClearReferenceObjects( const int theTag = 0 );
384   
385 protected:
386
387   /**
388    * Dump the initial object creation to a Python script.
389    * You should call it from DumpToPython implementation before 
390    * dumping fields of the object.
391    */
392   HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
393
394   /**
395    * Returns an object type name as a string for dumping to Python.
396    */
397   QString getPyTypeID() const;
398
399   void setPythonReferenceObject( MapOfTreatedObjects&            theTreatedObjects,
400                                  QStringList&                    theScript,
401                                  const Handle(HYDROData_Entity)& theRefObject,
402                                  const QString&                  theMethod ) const;
403
404   bool checkObjectPythonDefinition( MapOfTreatedObjects&            theTreatedObjects,
405                                     QStringList&                    theScript,
406                                     const Handle(HYDROData_Entity)& theRefObject ) const;
407
408   void setPythonObjectColor( QStringList&         theScript,
409                              const QColor&        theColor,
410                              const QColor&        theDefaultColor,
411                              const QString&       theMethod ) const;
412
413 protected:
414
415   Handle(TDataStd_ReferenceList) getReferenceList( const int  theTag,
416                                                    const bool theIsCreate ) const;
417
418
419 protected:
420   /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
421   TDF_Label myLab; ///< label of this object
422 };
423
424 #endif