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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Bathymetry_HeaderFile
20 #define HYDROData_Bathymetry_HeaderFile
22 #include "HYDROData_IAltitudeObject.h"
26 class Handle_HYDROData_PolylineXY;
28 DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_IAltitudeObject)
31 /**\class HYDROData_Bathymetry
32 * \brief Class that stores/retreives information about the Bathymetry.
34 * The Bathymetry represents measurement of the altitude of points on the terrain.
36 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
40 typedef gp_XYZ AltitudePoint;
41 typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
46 * Enumeration of tags corresponding to the persistent object parameters.
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
58 DEFINE_STANDARD_RTTI(HYDROData_Bathymetry);
61 * Returns the kind of this object. Must be redefined in all objects of known type.
63 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
67 * Dump Bathymetry object to Python script representation.
69 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
72 // Public methods to work with Bathymetry altitudes.
75 * Replace current altitude points by new one.
76 * \param thePoints the altitude points list
78 HYDRODATA_EXPORT virtual void SetAltitudePoints( const AltitudePoints& thePoints );
81 * Returns altitude points list.
84 HYDRODATA_EXPORT virtual AltitudePoints GetAltitudePoints(bool IsConvertToGlobal = false) const;
87 * Remove all altitude points.
89 HYDRODATA_EXPORT virtual void RemoveAltitudePoints();
92 * Returns altitude for given point.
93 * \param thePoint the point to examine
94 * \return altitude value
96 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
99 // Public methods to work with files.
102 * Stores the bathymetry file path
103 * \param theFilePath image file path
105 HYDRODATA_EXPORT void SetFilePath( const TCollection_AsciiString& theFilePath );
108 * Returns uploaded bathymetry file path
110 HYDRODATA_EXPORT TCollection_AsciiString GetFilePath() const;
113 * Set flag indicating needs to invert altitude values
114 * \param theIsInverted new invert value
115 * \param theIsUpdate flag indicating necessity to update points
117 HYDRODATA_EXPORT void SetAltitudesInverted( const bool theIsInverted,
118 const bool theIsUpdate = true );
121 * Returns flag indicating needs to invert altitude values.
123 HYDRODATA_EXPORT bool IsAltitudesInverted() const;
126 * Imports Bathymetry data from file. The supported file types:
128 * \param theFileName the path to file
129 * \return \c true if file has been successfully read
131 HYDRODATA_EXPORT virtual bool ImportFromFile( const TCollection_AsciiString& theFileName );
133 HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
135 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
140 * Imports Bathymetry data from 'XYZ' file.
142 bool importFromXYZFile( QFile& theFile,
143 AltitudePoints& thePoints ) const;
145 bool importFromASCFile( QFile& theFile,
146 AltitudePoints& thePoints ) const;
150 friend class HYDROData_Iterator;
153 * Creates new object in the internal data structure. Use higher level objects
154 * to create objects with real content.
156 HYDRODATA_EXPORT HYDROData_Bathymetry();
159 * Destructs properties of the object and object itself, removes it from the document.
161 HYDRODATA_EXPORT ~HYDROData_Bathymetry();