src/HYDROPy/HYDROData_IInterpolator.sip

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