src/HYDROData/HYDROData_ObstacleAltitude.h

   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 #ifndef HYDROData_ObstacleAltitude_HeaderFile
  20 #define HYDROData_ObstacleAltitude_HeaderFile
  21
  22
  23 #include "HYDROData_IAltitudeObject.h"
  24
  25 #define _DEVDEBUG_
  26 #include "HYDRO_trace.hxx"
  27
  28
  29 DEFINE_STANDARD_HANDLE(HYDROData_ObstacleAltitude, HYDROData_IAltitudeObject)
  30
  31
  32 /**\class HYDROData_ObstacleAltitude
  33  * \brief Class that stores/retreives information about the obstacle altitude.
  34  *
  35  */
  36 class HYDROData_ObstacleAltitude : public HYDROData_IAltitudeObject
  37 {
  38 protected:
  39
  40   /**
  41    * Enumeration of tags corresponding to the persistent object parameters.
  42    */
  43   enum DataTag
  44   {
  45     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  46   };
  47
  48 public:
  49
  50   DEFINE_STANDARD_RTTI(HYDROData_ObstacleAltitude);
  51
  52   /**
  53    * Returns the kind of this object.
  54    */
  55   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { DEBTRACE("HYDROData_ObstacleAltitude::GetKind"); return KIND_OBSTACLE_ALTITUDE; }
  56
  57 public:
  58
  59   // Public methods to work with altitudes.
  60
  61   /**
  62    * Returns altitude for given point.
  63    * \param thePoint the point to examine
  64    * \return altitude value
  65    */
  66   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
  67
  68 protected:
  69
  70   friend class HYDROData_Iterator;
  71
  72   /**
  73    * Creates new object in the internal data structure. Use higher level objects
  74    * to create objects with real content.
  75    */
  76   HYDRODATA_EXPORT HYDROData_ObstacleAltitude();
  77
  78   /**
  79    * Destructs properties of the object and object itself, removes it from the document.
  80    */
  81   HYDRODATA_EXPORT  ~HYDROData_ObstacleAltitude();
  82 };
  83
  84 #endif