]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_IInterpolator.h
Salome HOME
Merge branch 'BR_v14_rc' into BR_SINUSX_FORMAT
[modules/hydro.git] / src / HYDROData / HYDROData_IInterpolator.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_IInterpolator_HeaderFile
20 #define HYDROData_IInterpolator_HeaderFile
21
22 #include "HYDROData_IAltitudeObject.h"
23
24 class gp_XY;
25
26 /**\class HYDROData_IInterpolator
27  * \brief The base class to provide interface for interpolation.
28  */
29 class HYDROData_IInterpolator
30 {
31 public:
32
33   /**
34    * Public empty constructor.
35    */
36   HYDRODATA_EXPORT HYDROData_IInterpolator();
37
38   /**
39    * Public virtual destructor.
40    */
41   virtual HYDRODATA_EXPORT ~HYDROData_IInterpolator();
42
43 public:
44
45   /**
46    * Returns the altitude value for given point.
47    * Reimplement this method in order to change the interpolation algorithm.
48    */
49   virtual HYDRODATA_EXPORT double GetAltitudeForPoint( 
50     const double theCoordX, const double theCoordY ) const;
51
52   /**
53    * Returns the altitude value for given point.
54    */
55   HYDRODATA_EXPORT double GetAltitudeForPoint( const gp_XY& thePoint ) const;
56
57
58 public:
59
60   /**
61    * Sets the altitude object for interpolation.
62    */
63   HYDRODATA_EXPORT void SetAltitudeObject( 
64     const Handle(HYDROData_IAltitudeObject)& theAltitude );
65
66   /**
67    * Returns the altitude object for interpolation.
68    */
69   HYDRODATA_EXPORT Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
70
71 private:
72   Handle(HYDROData_IAltitudeObject)  myAltitudeObject;
73 };
74
75 #endif