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( const QString& thePyScriptPath,
  71                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  72
  73 public:
  74   // Public methods to work with Bathymetry altitudes.
  75
  76   /**
  77    * Replace current altitude points by new one.
  78    * \param thePoints the altitude points list
  79    */
  80   HYDRODATA_EXPORT virtual void             SetAltitudePoints( const AltitudePoints& thePoints );
  81
  82   /**
  83    * Returns altitude points list.
  84    * \return points list
  85    */
  86   HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints(bool IsConvertToGlobal = false) const;
  87   HYDRODATA_EXPORT virtual HYDROData_QuadtreeNode* GetQuadtreeNodes() const;
  88
  89   /**
  90    * Remove all altitude points.
  91    */
  92   HYDRODATA_EXPORT virtual void             RemoveAltitudePoints();
  93
  94   /**
  95    * Returns altitude for given point.
  96    * \param thePoint the point to examine
  97    * \return altitude value
  98    */
  99   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
 100
 101 public:
 102   // Public methods to work with files.
 103
 104   /**
 105    * Stores the bathymetry file path
 106    * \param theFilePath image file path
 107    */
 108   HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 109
 110   /**
 111    * Returns uploaded bathymetry file path
 112    */
 113   HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
 114
 115   /**
 116    * Set flag indicating needs to invert altitude values
 117    * \param theIsInverted new invert value
 118    * \param theIsUpdate flag indicating necessity to update points
 119    */
 120   HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
 121                                                                   const bool theIsUpdate = true );
 122
 123   /**
 124    * Returns flag indicating needs to invert altitude values.
 125    */
 126   HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 127
 128   /**
 129    * Imports Bathymetry data from file. The supported file types:
 130    *  - xyz
 131    * \param theFileName the path to file
 132    * \return \c true if file has been successfully read
 133    */
 134   HYDRODATA_EXPORT virtual bool             ImportFromFile( const TCollection_AsciiString& theFileName );
 135
 136   HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
 137
 138   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 139
 140 private:
 141
 142   /**
 143    * Imports Bathymetry data from 'XYZ' file.
 144    */
 145   bool                                      importFromXYZFile( QFile&          theFile,
 146                                                                AltitudePoints& thePoints ) const;
 147   static std::map<int, HYDROData_QuadtreeNode*> myQuadtrees;
 148
 149   bool                                      importFromASCFile( QFile&          theFile,
 150                                                                AltitudePoints& thePoints ) const;
 151
 152 protected:
 153
 154   friend class HYDROData_Iterator;
 155
 156   /**
 157    * Creates new object in the internal data structure. Use higher level objects
 158    * to create objects with real content.
 159    */
 160   HYDRODATA_EXPORT HYDROData_Bathymetry();
 161
 162   /**
 163    * Destructs properties of the object and object itself, removes it from the document.
 164    */
 165   HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 166 };
 167
 168 #endif