1 // Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROData_Bathymetry_HeaderFile
24 #define HYDROData_Bathymetry_HeaderFile
26 #include "HYDROData_IAltitudeObject.h"
30 class Handle_HYDROData_PolylineXY;
32 DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_IAltitudeObject)
35 /**\class HYDROData_Bathymetry
36 * \brief Class that stores/retreives information about the Bathymetry.
38 * The Bathymetry represents measurement of the altitude of points on the terrain.
40 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
44 typedef gp_XYZ AltitudePoint;
45 typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
50 * Enumeration of tags corresponding to the persistent object parameters.
54 DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
55 DataTag_AltitudePoints, ///< altitude points, array of reals
56 DataTag_FilePath, ///< bathymetry imported file path
57 DataTag_AltitudesInverted, ///< flag to invert z values
62 DEFINE_STANDARD_RTTI(HYDROData_Bathymetry);
65 * Returns the kind of this object. Must be redefined in all objects of known type.
67 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_BATHYMETRY; }
71 * Dump Bathymetry object to Python script representation.
73 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
76 // Public methods to work with Bathymetry altitudes.
79 * Replace current altitude points by new one.
80 * \param thePoints the altitude points list
82 HYDRODATA_EXPORT virtual void SetAltitudePoints( const AltitudePoints& thePoints );
85 * Returns altitude points list.
88 HYDRODATA_EXPORT virtual AltitudePoints GetAltitudePoints() const;
91 * Remove all altitude points.
93 HYDRODATA_EXPORT virtual void RemoveAltitudePoints();
96 * Returns altitude for given point.
97 * \param thePoint the point to examine
98 * \return altitude value
100 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
103 // Public methods to work with files.
106 * Stores the bathymetry file path
107 * \param theFilePath image file path
109 HYDRODATA_EXPORT void SetFilePath( const TCollection_AsciiString& theFilePath );
112 * Returns uploaded bathymetry file path
114 HYDRODATA_EXPORT TCollection_AsciiString GetFilePath() const;
117 * Set flag indicating needs to invert altitude values
118 * \param theIsInverted new invert value
119 * \param theIsUpdate flag indicating necessity to update points
121 HYDRODATA_EXPORT void SetAltitudesInverted( const bool theIsInverted,
122 const bool theIsUpdate = true );
125 * Returns flag indicating needs to invert altitude values.
127 HYDRODATA_EXPORT bool IsAltitudesInverted() const;
130 * Imports Bathymetry data from file. The supported file types:
132 * \param theFileName the path to file
133 * \return \c true if file has been successfully read
135 HYDRODATA_EXPORT virtual bool ImportFromFile( const TCollection_AsciiString& theFileName );
137 HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
139 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
144 * Imports Bathymetry data from 'XYZ' file.
146 bool importFromXYZFile( QFile& theFile,
147 AltitudePoints& thePoints ) const;
149 bool importFromASCFile( QFile& theFile,
150 AltitudePoints& thePoints ) const;
154 friend class HYDROData_Iterator;
157 * Creates new object in the internal data structure. Use higher level objects
158 * to create objects with real content.
160 HYDRODATA_EXPORT HYDROData_Bathymetry();
163 * Destructs properties of the object and object itself, removes it from the document.
165 HYDRODATA_EXPORT ~HYDROData_Bathymetry();