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