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 #include <NCollection_Sequence.hxx>
  24 #include <TDF_Label.hxx>
  25 #include <QMap>
  26 #include <QString>
  27 #include <Standard_Type.hxx>
  28 #include <MMgt_TShared.hxx>
  29
  30 #ifdef NONLS
  31 #undef NONLS
  32 #endif
  33
  34 #ifdef NOMINMAX
  35 #undef NOMINMAX
  36 #endif
  37
  38 class QColor;
  39 class QVariant;
  40 class QStringList;
  41 class TDataStd_ReferenceList;
  42 class HYDROData_Entity;
  43 class TopoDS_Shape;
  44
  45 ///! Kind of an object in a document
  46 typedef int ObjectKind;
  47
  48 const ObjectKind KIND_UNKNOWN             = 0; ///! Unrecognized object
  49 const ObjectKind KIND_IMAGE               = 1;
  50 const ObjectKind KIND_POLYLINE            = 2;
  51 const ObjectKind KIND_BATHYMETRY          = 3;
  52 const ObjectKind KIND_ALTITUDE            = 4;
  53 const ObjectKind KIND_IMMERSIBLE_ZONE     = 5;
  54 const ObjectKind KIND_RIVER               = 6;
  55 const ObjectKind KIND_STREAM              = 7;
  56 const ObjectKind KIND_CONFLUENCE          = 8;
  57 const ObjectKind KIND_CHANNEL             = 9;
  58 const ObjectKind KIND_OBSTACLE            = 10;
  59 const ObjectKind KIND_DIGUE               = 11;
  60 const ObjectKind KIND_PROFILE             = 12;
  61 const ObjectKind KIND_PROFILEUZ           = 13;
  62 const ObjectKind KIND_POLYLINEXY          = 14;
  63 const ObjectKind KIND_CALCULATION         = 15;
  64 const ObjectKind KIND_ZONE                = 16;
  65 const ObjectKind KIND_REGION              = 17;
  66 const ObjectKind KIND_VISUAL_STATE        = 18;
  67 const ObjectKind KIND_ARTIFICIAL_OBJECT   = 19;
  68 const ObjectKind KIND_NATURAL_OBJECT      = 20;
  69 const ObjectKind KIND_DUMMY_3D            = 21;
  70 const ObjectKind KIND_SHAPES_GROUP        = 22;
  71 const ObjectKind KIND_SPLIT_GROUP         = 23;
  72 const ObjectKind KIND_STREAM_ALTITUDE     = 24;
  73 const ObjectKind KIND_OBSTACLE_ALTITUDE   = 25;
  74 const ObjectKind KIND_STRICKLER_TABLE     = 26;
  75 const ObjectKind KIND_LAND_COVER_OBSOLETE = 27;
  76 const ObjectKind KIND_CHANNEL_ALTITUDE    = 28;
  77 const ObjectKind KIND_LAND_COVER_MAP      = 29;
  78 const ObjectKind KIND_DTM                 = 30;
  79 const ObjectKind KIND_LAST                = KIND_DTM+1;
  80
  81 class MapOfTreatedObjects : public QMap<QString,Handle(Standard_Transient)>
  82 {
  83 };
  84
  85 class HYDRODATA_EXPORT HYDROData_SequenceOfObjects : public NCollection_Sequence<Handle(HYDROData_Entity)>
  86 {
  87 public:
  88   HYDROData_SequenceOfObjects();
  89   HYDROData_SequenceOfObjects( const HYDROData_SequenceOfObjects& );
  90   HYDROData_SequenceOfObjects( const NCollection_Sequence<Handle(HYDROData_Entity)>& );
  91 };
  92
  93 ///! Is Equal for HYDROData_Entity mapping
  94 HYDRODATA_EXPORT bool IsEqual(const Handle(HYDROData_Entity)& theObj1, const Handle(HYDROData_Entity)& theObj2);
  95
  96 /**\class HYDROData_Entity
  97  * \brief Generic class of any object in the data model.
  98  *
  99  * Interface for getting access to the object that belong to the data model.
 100  * Managed by Document. Provides access to the common properties:
 101  * kind of an object, name.
 102  */
 103 class HYDROData_Entity : public MMgt_TShared
 104 {
 105 protected:
 106   /**
 107    * Enumeration of tags corresponding to the persistent object parameters.
 108    */
 109   enum DataTag
 110   {
 111     DataTag_First  = 0,     ///< first tag, to reserve
 112     DataTag_ZLevel,         ///< z-level of object presentation
 113     DataTag_GeomChange,
 114     DataTag_DefaultName,    ///< to keep the automatic name, useful in Python dump
 115   };
 116
 117 public:
 118   enum Geometry
 119   {
 120     Geom_No = 1,
 121     Geom_2d = 2,
 122     Geom_Z  = 4,
 123     Geom_Groups = 8,
 124
 125     Geom_3d = Geom_2d | Geom_Z,
 126     Geom_2d_and_groups = Geom_2d | Geom_Groups,
 127     Geom_All = Geom_3d | Geom_Groups | Geom_No,
 128   };
 129
 130 public:
 131   DEFINE_STANDARD_RTTIEXT(HYDROData_Entity, MMgt_TShared);
 132
 133   HYDRODATA_EXPORT static QString Type( ObjectKind );
 134   HYDRODATA_EXPORT virtual QString GetType() const;
 135
 136   /**
 137    * Returns the kind of this object. Must be redefined in all objects of known type.
 138    */
 139   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
 140
 141   /**
 142    * Returns the name of this object.
 143    */
 144   HYDRODATA_EXPORT virtual QString GetName() const;
 145
 146   /**
 147    * Returns the default name of this object.
 148    */
 149   HYDRODATA_EXPORT virtual QString GetDefaultName() const;
 150
 151   /**
 152    * Updates the name of this object.
 153    */
 154   HYDRODATA_EXPORT void SetName( const QString& theName, bool isDefault = false );
 155
 156   /**
 157    * Returns the name of this object valid for Python script.
 158    */
 159   HYDRODATA_EXPORT virtual QString GetObjPyName() const;
 160
 161   /**
 162    * Dump object to Python script representation.
 163    * Base implementation returns empty list,
 164    * You should reimplement this function in your derived class if it
 165    * has Python API and can be imported/exported from/to Python script.
 166    */
 167   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
 168                                                      MapOfTreatedObjects& theTreatedObjects ) const;
 169
 170   /**
 171    * Updates object state. Base implementation dose nothing.
 172    */
 173   HYDRODATA_EXPORT virtual void Update();
 174
 175   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 176
 177   /**
 178    * Checks that object has 2D presentation. Base implementation returns false.
 179    */
 180   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 181
 182   /**
 183    * Show object at the top of other model objects.
 184    */
 185   HYDRODATA_EXPORT virtual void Show();
 186
 187
 188   /**
 189    * Returns data of object wrapped to QVariant.
 190    * Base implementation returns null value.
 191    */
 192   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
 193
 194
 195
 196   HYDRODATA_EXPORT virtual void ClearChanged();
 197   HYDRODATA_EXPORT virtual void Changed( Geometry );
 198
 199   HYDRODATA_EXPORT bool IsMustBeUpdated( Geometry ) const;
 200
 201   /**
 202    * Returns flag indicating that object is updateble or not.
 203    */
 204   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
 205
 206
 207   /**
 208    * Checks is object exists in the data structure.
 209    * \returns true is object is not exists in the data model
 210    */
 211   HYDRODATA_EXPORT bool IsRemoved() const;
 212
 213   /**
 214    * Removes object and it child sub-objects from the data structure.
 215    */
 216   HYDRODATA_EXPORT virtual void Remove();
 217
 218   /**
 219    * Returns flag indicating that object can be removed or not.
 220    * Reimplement this method in class which can't be removed
 221    * separately with it parent object.
 222    * Base implementaiton returns always TRUE.
 223    */
 224   HYDRODATA_EXPORT virtual bool CanRemove();
 225
 226   /**
 227    * Copies all properties of this to the destinated object.
 228    * Objects must be the same type.
 229    * \param theDestination initialized object (from any document) - target of copying
 230    */
 231   HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination,
 232                                         bool isGenerateNewName ) const;
 233
 234   /**
 235    * Returns the label of this object.
 236    */
 237   HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
 238
 239
 240   /**
 241    * Returns father object. For object created under root document label
 242    * this method always return NULL object.
 243    */
 244   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
 245
 246
 247   /**
 248    * Returns the list of all reference objects of this object.
 249    * Base implementation always return empty list.
 250    */
 251   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 252
 253
 254   /**
 255    * Returns the z-level for object presentation, -1 if no z-level.
 256    */
 257   HYDRODATA_EXPORT virtual bool GetZLevel( Standard_Integer& theLevel ) const;
 258
 259   /**
 260    * Set the z-level for object presentation.
 261    */
 262   HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
 263
 264   /**
 265    * Remove the z-level of object presentation.
 266    */
 267   HYDRODATA_EXPORT virtual void RemoveZLevel();
 268
 269   /**
 270     Add in Python script the find instruction, to retrieve the Python object in the document by the object name.
 271     @param theScript the script
 272     @param defName the name to use, if not default name.
 273   */
 274   void findPythonReferenceObject( QStringList&                    theScript,
 275                                   QString                         defName = QString()) const;
 276
 277   /**
 278     Add in Python script the set name instruction.
 279     @param theScript the script
 280     @param defName the name to use, if not default name.
 281   */
 282  void SetNameInDumpPython(QStringList&                           theScript,
 283                           QString                                theName = QString()) const;
 284
 285     /**
 286    * Internal method that used to store the color attribute
 287    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 288    * \param theColor color to save
 289    */
 290   HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
 291
 292   /**
 293    * Internal method that used to retreive the color attribute
 294    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 295    * \param theDefColor default color to return if attribute has not been set before
 296    */
 297   HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
 298
 299 protected:
 300
 301   friend class HYDROData_Iterator;
 302
 303   /**
 304    * Creates new object in the internal data structure. Use higher level objects
 305    * to create objects with real content.
 306    */
 307   HYDRODATA_EXPORT HYDROData_Entity( Geometry );
 308
 309   /**
 310    * Destructs properties of the object and object itself, removes it from the document.
 311    */
 312   virtual HYDRODATA_EXPORT ~HYDROData_Entity();
 313
 314   /**
 315    * Put the object to the label of the document.
 316    * \param theLabel new label of the object
 317    */
 318   HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
 319
 320   /**
 321    * Internal method that used to store the byte array attribute
 322    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 323    * \param theData pointer to bytes array
 324    * \param theLen number of bytes in byte array that must be stored
 325    */
 326   void SaveByteArray(const int theTag, const char* theData, const int theLen);
 327
 328   /**
 329    * Internal method that used to retreive the content of byte array attribute
 330    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 331    * \param theLen number of bytes in byte array
 332    * \returns pointer to the internal data structure wit harray content,
 333    *          or NULL if array size is zero
 334    */
 335   const char* ByteArray(const int theTag, int& theLen) const;
 336
 337   /**
 338    * Internal method that used to store the reference object label attribute
 339    * \param theObj pointer to reference object
 340    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 341    */
 342   int NbReferenceObjects( const int theTag = 0 ) const;
 343
 344   /**
 345    * Internal method that used to check object for entry into the reference list
 346    * \param theObj pointer to reference object
 347    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 348    */
 349   bool HasReference( const Handle(HYDROData_Entity)& theObj,
 350                      const int                      theTag = 0 ) const;
 351
 352   /**
 353    * Internal method that used to store the reference object label attribute
 354    * \param theObj pointer to reference object
 355    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 356    */
 357   void AddReferenceObject( const Handle(HYDROData_Entity)& theObj,
 358                            const int                      theTag = 0 );
 359
 360   /**
 361    * Internal method that used to store the reference object label attribute
 362    * \param theObj pointer to reference object
 363    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 364    * \param theIndex index in the list of references
 365              - if more that len then just append it to the end of list
 366              - if less than zero then prepend to the list
 367              - indexing starts from 0
 368    */
 369   void SetReferenceObject( const Handle(HYDROData_Entity)& theObj,
 370                            const int                      theTag = 0,
 371                            const int                      theIndex = 0 );
 372
 373   /**
 374    * Internal method that used to store the reference object label attribute
 375    * \param theObj pointer to reference object
 376    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 377    * \param theBeforeIndex index in the list of references
 378              - if more that len then just append it to the end of list
 379              - if less than zero then prepend to the list
 380              - indexing starts from 0
 381    */
 382   void InsertReferenceObject( const Handle(HYDROData_Entity)& theObj,
 383                               const int                      theTag = 0,
 384                               const int                      theBeforeIndex = 0 );
 385
 386   /**
 387    * Internal method that used to store the reference object label attribute
 388    * \param theObjects sequence with pointers to reference objects
 389    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 390    */
 391   void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
 392                             const int                          theTag = 0 );
 393
 394   /**
 395    * Internal method that used to retreive the reference object(s) attribute
 396    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 397    * \param theIndex index in the list of references
 398    *        - indexing starts from 0
 399    * \returns pointer to reference object or NULL if label is not set
 400    */
 401   Handle(HYDROData_Entity) GetReferenceObject( const int theTag   = 0,
 402                                               const int theIndex = 0 ) const;
 403
 404   HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
 405
 406   /**
 407    * Internal method that used to remove the reference object attribute
 408    * \param theRefLabel reference object label to remove
 409    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 410    */
 411   void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
 412
 413   /**
 414    * Internal method that used to remove the reference object attribute
 415    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 416    * \param theIndex index in the list of references
 417    *        - indexing starts from 0
 418    */
 419   void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
 420
 421   /**
 422    * Internal method that used to clear list of the reference objects attribute
 423    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 424    */
 425   void ClearReferenceObjects( const int theTag = 0 );
 426
 427 public:
 428
 429    HYDRODATA_EXPORT virtual bool CompareLabels(const Handle(HYDROData_Entity)& theOtherObj);
 430
 431 protected:
 432
 433   /**
 434    * Dump the initial object creation to a Python script.
 435    * You should call it from DumpToPython implementation before
 436    * dumping fields of the object.
 437    */
 438   HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
 439
 440   /**
 441    * Returns an object type name as a string for dumping to Python.
 442    */
 443   QString getPyTypeID() const;
 444
 445   void setPythonReferenceObject( const QString&                  thePyScriptPath,
 446                                  MapOfTreatedObjects&            theTreatedObjects,
 447                                  QStringList&                    theScript,
 448                                  const Handle(HYDROData_Entity)& theRefObject,
 449                                  const QString&                  theMethod ) const;
 450
 451   bool checkObjectPythonDefinition( const QString&                  thePyScriptPath,
 452                                     MapOfTreatedObjects&            theTreatedObjects,
 453                                     QStringList&                    theScript,
 454                                     const Handle(HYDROData_Entity)& theRefObject ) const;
 455
 456   void setPythonObjectColor( QStringList&         theScript,
 457                              const QColor&        theColor,
 458                              const QColor&        theDefaultColor,
 459                              const QString&       theMethod ) const;
 460 protected:
 461
 462   Handle(TDataStd_ReferenceList) getReferenceList( const int  theTag,
 463                                                    const bool theIsCreate ) const;
 464
 465   void SetShape( int theTag, const TopoDS_Shape& theShape );
 466   TopoDS_Shape GetShape( int theTag ) const;
 467
 468   void SetDouble( int theTag, double theValue );
 469   double GetDouble( int theTag, double theDefValue = 0.0 ) const;
 470
 471   void SetInteger( int theTag, int theValue );
 472   int GetInteger( int theTag, int theDefValue = 0 ) const;
 473
 474
 475   int GetGeomChangeFlag() const;
 476
 477 protected:
 478   /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
 479   TDF_Label myLab; ///< label of this object
 480   Geometry  myGeom;
 481 };
 482
 483 #endif