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