1 // Copyright (C) 2007-2013 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.
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
24 #include <HYDROData_Bathymetry.h>
27 class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
29 %ConvertToSubClassCode
30 switch ( sipCpp->GetKind() )
33 sipClass = sipClass_HYDROData_Bathymetry;
37 // We don't recognise the type.
42 typedef gp_XYZ AltitudePoint;
43 typedef NCollection_Sequence<gp_XYZ> AltitudePoints;
47 #include <HYDROData_Bathymetry.h>
51 // Public methods to work with Bathymetry altitudes.
54 * Returns altitude for given point.
55 * \param thePoint the point to examine
56 * \return altitude value
58 double GetAltitudeForPoint( const gp_XY& thePoint );
61 * Replace current altitude points by new one.
62 * \param thePoints the altitude points list
64 virtual void SetAltitudePoints( const HYDROData_Bathymetry::AltitudePoints& );
67 * Returns altitude points list.
70 HYDROData_Bathymetry::AltitudePoints GetAltitudePoints() const;
73 * Remove all altitude points.
75 void RemoveAltitudePoints();
79 // Public methods to work with files.
82 * Set flag indicating needs to invert altitude values
83 * \param theIsInverted new invert value
84 * \param theIsUpdate flag indicating necessity to update points
86 void SetAltitudesInverted( const bool theIsInverted,
87 const bool theIsUpdate = true );
90 * Returns flag indicating needs to invert altitude values.
92 bool IsAltitudesInverted() const;
95 * Imports Bathymetry data from file. The supported file types:
97 * \param theFileName the path to file
98 * \return \c true if file has been successfully read
100 bool ImportFromFile( const TCollection_AsciiString& theFileName );
106 * Creates new object in the internal data structure. Use higher level objects
107 * to create objects with real content.
109 HYDROData_Bathymetry();
112 * Destructs properties of the object and object itself, removes it from the document.
114 ~HYDROData_Bathymetry();