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
  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;
  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   /**
 134    * Returns the kind of this object. Must be redefined in all objects of known type.
 135    */
 136   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
 137
 138   /**
 139    * Returns the name of this object.
 140    */
 141   HYDRODATA_EXPORT virtual QString GetName() const;
 142
 143   /**
 144    * Returns the default name of this object.
 145    */
 146   HYDRODATA_EXPORT virtual QString GetDefaultName() const;
 147
 148   /**
 149    * Updates the name of this object.
 150    */
 151   HYDRODATA_EXPORT void SetName( const QString& theName, bool isDefault = false );
 152
 153   /**
 154    * Returns the name of this object valid for Python script.
 155    */
 156   HYDRODATA_EXPORT virtual QString GetObjPyName() const;
 157
 158   /**
 159    * Dump object to Python script representation.
 160    * Base implementation returns empty list,
 161    * You should reimplement this function in your derived class if it
 162    * has Python API and can be imported/exported from/to Python script.
 163    */
 164   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
 165                                                      MapOfTreatedObjects& theTreatedObjects ) const;
 166
 167   /**
 168    * Updates object state. Base implementation dose nothing.
 169    */
 170   HYDRODATA_EXPORT virtual void Update();
 171
 172   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 173
 174   /**
 175    * Checks that object has 2D presentation. Base implementation returns false.
 176    */
 177   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 178
 179   /**
 180    * Show object at the top of other model objects.
 181    */
 182   HYDRODATA_EXPORT virtual void Show();
 183
 184
 185   /**
 186    * Returns data of object wrapped to QVariant.
 187    * Base implementation returns null value.
 188    */
 189   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
 190
 191
 192
 193   HYDRODATA_EXPORT virtual void ClearChanged();
 194   HYDRODATA_EXPORT virtual void Changed( Geometry );
 195
 196   HYDRODATA_EXPORT bool IsMustBeUpdated( Geometry ) const;
 197
 198   /**
 199    * Returns flag indicating that object is updateble or not.
 200    */
 201   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
 202
 203
 204   /**
 205    * Checks is object exists in the data structure.
 206    * \returns true is object is not exists in the data model
 207    */
 208   HYDRODATA_EXPORT bool IsRemoved() const;
 209
 210   /**
 211    * Removes object and it child sub-objects from the data structure.
 212    */
 213   HYDRODATA_EXPORT virtual void Remove();
 214
 215   /**
 216    * Returns flag indicating that object can be removed or not.
 217    * Reimplement this method in class which can't be removed
 218    * separately with it parent object.
 219    * Base implementaiton returns always TRUE.
 220    */
 221   HYDRODATA_EXPORT virtual bool CanRemove();
 222
 223   /**
 224    * Copies all properties of this to the destinated object.
 225    * Objects must be the same type.
 226    * \param theDestination initialized object (from any document) - target of copying
 227    */
 228   HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination,
 229                                         bool isGenerateNewName ) const;
 230
 231   /**
 232    * Returns the label of this object.
 233    */
 234   HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
 235
 236
 237   /**
 238    * Returns father object. For object created under root document label
 239    * this method always return NULL object.
 240    */
 241   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
 242
 243
 244   /**
 245    * Returns the list of all reference objects of this object.
 246    * Base implementation always return empty list.
 247    */
 248   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 249
 250
 251   /**
 252    * Returns the z-level for object presentation, -1 if no z-level.
 253    */
 254   HYDRODATA_EXPORT virtual bool GetZLevel( Standard_Integer& theLevel ) const;
 255
 256   /**
 257    * Set the z-level for object presentation.
 258    */
 259   HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
 260
 261   /**
 262    * Remove the z-level of object presentation.
 263    */
 264   HYDRODATA_EXPORT virtual void RemoveZLevel();
 265
 266   /**
 267     Add in Python script the find instruction, to retrieve the Python object in the document by the object name.
 268     @param theScript the script
 269     @param defName the name to use, if not default name.
 270   */
 271   void findPythonReferenceObject( QStringList&                    theScript,
 272                                   QString                         defName = QString()) const;
 273
 274   /**
 275     Add in Python script the set name instruction.
 276     @param theScript the script
 277     @param defName the name to use, if not default name.
 278   */
 279  void SetNameInDumpPython(QStringList&                           theScript,
 280                           QString                                theName = QString()) const;
 281
 282     /**
 283    * Internal method that used to store the color attribute
 284    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 285    * \param theColor color to save
 286    */
 287   HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
 288
 289   /**
 290    * Internal method that used to retreive the color attribute
 291    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 292    * \param theDefColor default color to return if attribute has not been set before
 293    */
 294   HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
 295
 296 protected:
 297
 298   friend class HYDROData_Iterator;
 299
 300   /**
 301    * Creates new object in the internal data structure. Use higher level objects
 302    * to create objects with real content.
 303    */
 304   HYDRODATA_EXPORT HYDROData_Entity( Geometry );
 305
 306   /**
 307    * Destructs properties of the object and object itself, removes it from the document.
 308    */
 309   virtual HYDRODATA_EXPORT ~HYDROData_Entity();
 310
 311   /**
 312    * Put the object to the label of the document.
 313    * \param theLabel new label of the object
 314    */
 315   HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
 316
 317   /**
 318    * Internal method that used to store the byte array attribute
 319    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 320    * \param theData pointer to bytes array
 321    * \param theLen number of bytes in byte array that must be stored
 322    */
 323   void SaveByteArray(const int theTag, const char* theData, const int theLen);
 324
 325   /**
 326    * Internal method that used to retreive the content of byte array attribute
 327    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 328    * \param theLen number of bytes in byte array
 329    * \returns pointer to the internal data structure wit harray content,
 330    *          or NULL if array size is zero
 331    */
 332   const char* ByteArray(const int theTag, int& theLen) const;
 333
 334   /**
 335    * Internal method that used to store the reference object label attribute
 336    * \param theObj pointer to reference object
 337    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 338    */
 339   int NbReferenceObjects( const int theTag = 0 ) const;
 340
 341   /**
 342    * Internal method that used to check object for entry into the reference list
 343    * \param theObj pointer to reference object
 344    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 345    */
 346   bool HasReference( const Handle(HYDROData_Entity)& theObj,
 347                      const int                      theTag = 0 ) const;
 348
 349   /**
 350    * Internal method that used to store the reference object label attribute
 351    * \param theObj pointer to reference object
 352    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 353    */
 354   void AddReferenceObject( const Handle(HYDROData_Entity)& theObj,
 355                            const int                      theTag = 0 );
 356
 357   /**
 358    * Internal method that used to store the reference object label attribute
 359    * \param theObj pointer to reference object
 360    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 361    * \param theIndex index in the list of references
 362              - if more that len then just append it to the end of list
 363              - if less than zero then prepend to the list
 364              - indexing starts from 0
 365    */
 366   void SetReferenceObject( const Handle(HYDROData_Entity)& theObj,
 367                            const int                      theTag = 0,
 368                            const int                      theIndex = 0 );
 369
 370   /**
 371    * Internal method that used to store the reference object label attribute
 372    * \param theObj pointer to reference object
 373    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 374    * \param theBeforeIndex index in the list of references
 375              - if more that len then just append it to the end of list
 376              - if less than zero then prepend to the list
 377              - indexing starts from 0
 378    */
 379   void InsertReferenceObject( const Handle(HYDROData_Entity)& theObj,
 380                               const int                      theTag = 0,
 381                               const int                      theBeforeIndex = 0 );
 382
 383   /**
 384    * Internal method that used to store the reference object label attribute
 385    * \param theObjects sequence with pointers to reference objects
 386    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 387    */
 388   void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
 389                             const int                          theTag = 0 );
 390
 391   /**
 392    * Internal method that used to retreive the reference object(s) attribute
 393    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 394    * \param theIndex index in the list of references
 395    *        - indexing starts from 0
 396    * \returns pointer to reference object or NULL if label is not set
 397    */
 398   Handle(HYDROData_Entity) GetReferenceObject( const int theTag   = 0,
 399                                               const int theIndex = 0 ) const;
 400
 401   HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
 402
 403   /**
 404    * Internal method that used to remove the reference object attribute
 405    * \param theRefLabel reference object label to remove
 406    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 407    */
 408   void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
 409
 410   /**
 411    * Internal method that used to remove the reference object attribute
 412    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 413    * \param theIndex index in the list of references
 414    *        - indexing starts from 0
 415    */
 416   void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
 417
 418   /**
 419    * Internal method that used to clear list of the reference objects attribute
 420    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 421    */
 422   void ClearReferenceObjects( const int theTag = 0 );
 423
 424 public:
 425
 426    HYDRODATA_EXPORT virtual bool CompareLabels(const Handle(HYDROData_Entity)& theOtherObj);
 427
 428 protected:
 429
 430   /**
 431    * Dump the initial object creation to a Python script.
 432    * You should call it from DumpToPython implementation before
 433    * dumping fields of the object.
 434    */
 435   HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
 436
 437   /**
 438    * Returns an object type name as a string for dumping to Python.
 439    */
 440   QString getPyTypeID() const;
 441
 442   void setPythonReferenceObject( const QString&                  thePyScriptPath,
 443                                  MapOfTreatedObjects&            theTreatedObjects,
 444                                  QStringList&                    theScript,
 445                                  const Handle(HYDROData_Entity)& theRefObject,
 446                                  const QString&                  theMethod ) const;
 447
 448   bool checkObjectPythonDefinition( const QString&                  thePyScriptPath,
 449                                     MapOfTreatedObjects&            theTreatedObjects,
 450                                     QStringList&                    theScript,
 451                                     const Handle(HYDROData_Entity)& theRefObject ) const;
 452
 453   void setPythonObjectColor( QStringList&         theScript,
 454                              const QColor&        theColor,
 455                              const QColor&        theDefaultColor,
 456                              const QString&       theMethod ) const;
 457 protected:
 458
 459   Handle(TDataStd_ReferenceList) getReferenceList( const int  theTag,
 460                                                    const bool theIsCreate ) const;
 461
 462   void SetShape( int theTag, const TopoDS_Shape& theShape );
 463   TopoDS_Shape GetShape( int theTag ) const;
 464
 465   void SetDouble( int theTag, double theValue );
 466   double GetDouble( int theTag, double theDefValue = 0.0 ) const;
 467
 468   void SetInteger( int theTag, int theValue );
 469   int GetInteger( int theTag, int theDefValue = 0 ) const;
 470
 471
 472   int GetGeomChangeFlag() const;
 473
 474 protected:
 475   /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
 476   TDF_Label myLab; ///< label of this object
 477   Geometry  myGeom;
 478 };
 479
 480 #endif