]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_IInterpolator.h
Salome HOME
copyrights in HYDRO files are updated
[modules/hydro.git] / src / HYDROData / HYDROData_IInterpolator.h
1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 #ifndef HYDROData_IInterpolator_HeaderFile
24 #define HYDROData_IInterpolator_HeaderFile
25
26 #include "HYDROData_IAltitudeObject.h"
27
28 class gp_XY;
29
30 /**\class HYDROData_IInterpolator
31  * \brief The base class to provide interface for interpolation.
32  */
33 class HYDROData_IInterpolator
34 {
35 public:
36
37   /**
38    * Public empty constructor.
39    */
40   HYDRODATA_EXPORT HYDROData_IInterpolator();
41
42   /**
43    * Public virtual destructor.
44    */
45   virtual HYDRODATA_EXPORT ~HYDROData_IInterpolator();
46
47 public:
48
49   /**
50    * Returns the altitude value for given point.
51    * Reimplement this method in order to change the interpolation algorithm.
52    */
53   virtual HYDRODATA_EXPORT double GetAltitudeForPoint( 
54     const double theCoordX, const double theCoordY ) const;
55
56   /**
57    * Returns the altitude value for given point.
58    */
59   HYDRODATA_EXPORT double GetAltitudeForPoint( const gp_XY& thePoint ) const;
60
61
62 public:
63
64   /**
65    * Sets the altitude object for interpolation.
66    */
67   HYDRODATA_EXPORT void SetAltitudeObject( 
68     const Handle(HYDROData_IAltitudeObject)& theAltitude );
69
70   /**
71    * Returns the altitude object for interpolation.
72    */
73   HYDRODATA_EXPORT Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
74
75 private:
76   Handle(HYDROData_IAltitudeObject)  myAltitudeObject;
77 };
78
79 #endif