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