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