src/HYDROPy/HYDROData_IAltitudeObject.sip

   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 %ExportedHeaderCode
  20 #include <HYDROData_IAltitudeObject.h>
  21 %End
  22
  23 class HYDROData_IAltitudeObject : public HYDROData_Entity /Abstract/
  24 {
  25
  26 %ConvertToSubClassCode
  27     switch ( sipCpp->GetKind() )
  28     {
  29       case KIND_BATHYMETRY:
  30         sipClass = sipClass_HYDROData_Bathymetry;
  31         break;
  32
  33       case KIND_OBSTACLE_ALTITUDE:
  34         sipClass = sipClass_HYDROData_ObstacleAltitude;
  35         break;
  36
  37       case KIND_ALTITUDE:
  38         sipClass = sipClass_HYDROData_AltitudeObject;
  39         break;
  40
  41       case KIND_STREAM_ALTITUDE:
  42         sipClass = sipClass_HYDROData_StreamAltitude;
  43         break;
  44
  45       default:
  46         // We don't recognise the type.
  47         sipClass = NULL;
  48     }
  49 %End
  50
  51 %TypeHeaderCode
  52 #include <HYDROData_IAltitudeObject.h>
  53 %End
  54
  55 public:
  56   // Public methods to work with altitudes.
  57
  58   /**
  59    * Returns altitude points list.
  60    * \return points list
  61    */
  62   static double GetInvalidAltitude();
  63
  64   /**
  65    * Returns altitude for given point.
  66    * \param thePoint the point to examine
  67    * \return altitude value
  68    */
  69   virtual double GetAltitudeForPoint( const double theCoordX,
  70                                       const double theCoordX ) const = 0 [double ( const gp_XY& )];
  71   %MethodCode
  72     gp_XY aPnt( a0, a1 );
  73
  74     Py_BEGIN_ALLOW_THREADS
  75     sipRes = sipCpp->GetAltitudeForPoint( aPnt );
  76     Py_END_ALLOW_THREADS
  77   %End
  78   %VirtualCatcherCode
  79     PyObject *sipResObj = sipCallMethod(0, sipMethod, "dd",a0.X(),a0.Y());
  80
  81     sipParseResultEx(sipGILState, sipErrorHandler, sipPySelf, sipMethod, sipResObj, "d", &sipRes);
  82   %End
  83
  84 protected:
  85
  86   /**
  87    * Creates new object in the internal data structure. Use higher level objects
  88    * to create objects with real content.
  89    */
  90   HYDROData_IAltitudeObject();
  91
  92   /**
  93    * Destructs properties of the object and object itself, removes it from the document.
  94    */
  95   ~HYDROData_IAltitudeObject();
  96 };
  97
  98