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