src/HYDROData/HYDROData_Bathymetry.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_Bathymetry_HeaderFile
  20 #define HYDROData_Bathymetry_HeaderFile
  21
  22 #include "HYDROData_IAltitudeObject.h"
  23 #include "HYDROData_QuadtreeNode.hxx"
  24
  25 class QFile;
  26 class gp_XYZ;
  27 class Handle_HYDROData_PolylineXY;
  28
  29 DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_IAltitudeObject)
  30
  31
  32 /**\class HYDROData_Bathymetry
  33  * \brief Class that stores/retreives information about the Bathymetry.
  34  *
  35  * The Bathymetry represents measurement of the altitude of points on the terrain.
  36  */
  37 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
  38 {
  39 public:
  40
  41   typedef gp_XYZ                              AltitudePoint;
  42   typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
  43
  44 protected:
  45
  46   /**
  47    * Enumeration of tags corresponding to the persistent object parameters.
  48    */
  49   enum DataTag
  50   {
  51     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  52     DataTag_AltitudePoints,    ///< altitude points, array of reals
  53     DataTag_FilePath,          ///< bathymetry imported file path
  54     DataTag_AltitudesInverted, ///< flag to invert z values
  55   };
  56
  57 public:
  58
  59   DEFINE_STANDARD_RTTI(HYDROData_Bathymetry);
  60
  61   /**
  62    * Returns the kind of this object. Must be redefined in all objects of known type.
  63    */
  64   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
  65
  66
  67   /**
  68    * Dump Bathymetry object to Python script representation.
  69    */
  70   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  71
  72 public:
  73   // Public methods to work with Bathymetry altitudes.
  74
  75   /**
  76    * Replace current altitude points by new one.
  77    * \param thePoints the altitude points list
  78    */
  79   HYDRODATA_EXPORT virtual void             SetAltitudePoints( const AltitudePoints& thePoints );
  80
  81   /**
  82    * Returns altitude points list.
  83    * \return points list
  84    */
  85   HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints() const;
  86   HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
  87
  88   /**
  89    * Remove all altitude points.
  90    */
  91   HYDRODATA_EXPORT virtual void             RemoveAltitudePoints();
  92
  93   /**
  94    * Returns altitude for given point.
  95    * \param thePoint the point to examine
  96    * \return altitude value
  97    */
  98   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
  99
 100 public:
 101   // Public methods to work with files.
 102
 103   /**
 104    * Stores the bathymetry file path
 105    * \param theFilePath image file path
 106    */
 107   HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 108
 109   /**
 110    * Returns uploaded bathymetry file path
 111    */
 112   HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
 113
 114   /**
 115    * Set flag indicating needs to invert altitude values
 116    * \param theIsInverted new invert value
 117    * \param theIsUpdate flag indicating necessity to update points
 118    */
 119   HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
 120                                                                   const bool theIsUpdate = true );
 121
 122   /**
 123    * Returns flag indicating needs to invert altitude values.
 124    */
 125   HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 126
 127   /**
 128    * Imports Bathymetry data from file. The supported file types:
 129    *  - xyz
 130    * \param theFileName the path to file
 131    * \return \c true if file has been successfully read
 132    */
 133   HYDRODATA_EXPORT virtual bool             ImportFromFile( const TCollection_AsciiString& theFileName );
 134
 135   HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
 136
 137   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 138
 139 private:
 140
 141   /**
 142    * Imports Bathymetry data from 'XYZ' file.
 143    */
 144   bool                                      importFromXYZFile( QFile&          theFile,
 145                                                                AltitudePoints& thePoints ) const;
 146   static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
 147
 148   bool                                      importFromASCFile( QFile&          theFile,
 149                                                                AltitudePoints& thePoints ) const;
 150
 151 protected:
 152
 153   friend class HYDROData_Iterator;
 154
 155   /**
 156    * Creates new object in the internal data structure. Use higher level objects
 157    * to create objects with real content.
 158    */
 159   HYDRODATA_EXPORT HYDROData_Bathymetry();
 160
 161   /**
 162    * Destructs properties of the object and object itself, removes it from the document.
 163    */
 164   HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 165 };
 166
 167 #endif