Salome HOME
refs #514: use specific cursors for edition operations.
[modules/hydro.git] / src / HYDROPy / HYDROData_IInterpolator.sip
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 %ExportedHeaderCode
24 #include <HYDROData_IInterpolator.h>
25 %End
26
27 /**\class HYDROData_IInterpolator
28  * \brief The base class to provide interface for interpolation.
29  */
30 class HYDROData_IInterpolator
31 {
32 %TypeHeaderCode
33 #include <HYDROData_IInterpolator.h>
34 %End
35
36 public:
37
38   /**
39    * Public empty constructor.
40    */
41   HYDROData_IInterpolator();
42
43   /**
44    * Public virtual destructor.
45    */
46   virtual ~HYDROData_IInterpolator();
47   
48 public:
49
50   /**
51    * Returns the altitude value for given point.
52    * Reimplement this method in order to change the interpolation algorithm.
53    */
54   virtual double GetAltitudeForPoint( const double theCoordX,
55                                       const double theCoordY ) const;
56
57 public:
58
59   /**
60    * Sets the altitude object for interpolation.
61    */
62   void SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) 
63   [void ( const Handle_HYDROData_IAltitudeObject& )];
64   %MethodCode
65     Handle(HYDROData_IAltitudeObject) anAltitude =
66       Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
67     if ( !anAltitude.IsNull() )
68     {
69       Py_BEGIN_ALLOW_THREADS
70       sipSelfWasArg ? sipCpp->HYDROData_IInterpolator::SetAltitudeObject( anAltitude ):
71                       sipCpp->SetAltitudeObject( anAltitude );
72       Py_END_ALLOW_THREADS
73
74     }
75   %End
76
77
78   /**
79    * Returns the altitude object for interpolation.
80    */
81   HYDROData_IAltitudeObject GetAltitudeObject() const [Handle_HYDROData_IAltitudeObject ()];
82   %MethodCode
83     Handle(HYDROData_IAltitudeObject) aRes;
84     
85     Py_BEGIN_ALLOW_THREADS
86     aRes = sipSelfWasArg ? sipCpp->HYDROData_IInterpolator::GetAltitudeObject() : 
87                            sipCpp->GetAltitudeObject();
88     Py_END_ALLOW_THREADS
89     
90     sipRes = (HYDROData_IAltitudeObject*)createPointer( aRes );
91   %End
92 };