src/HYDROData/HYDROData_IAltitudeObject.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_IAltitudeObject_HeaderFile
  20 #define HYDROData_IAltitudeObject_HeaderFile
  21
  22 #include "HYDROData_Entity.h"
  23
  24 class gp_XY;
  25
  26
  27 /**\class HYDROData_IAltitudeObject
  28  * \briefThe base class for all altitude objects in the HYDRO module.
  29  *
  30  */
  31 class HYDROData_IAltitudeObject : public HYDROData_Entity
  32 {
  33 protected:
  34
  35   /**
  36    * Enumeration of tags corresponding to the persistent object parameters.
  37    */
  38   enum DataTag
  39   {
  40     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  41   };
  42
  43 public:
  44   DEFINE_STANDARD_RTTIEXT(HYDROData_IAltitudeObject, HYDROData_Entity);
  45
  46   /**
  47    * Returns the kind of this object. Must be redefined in all objects of known type.
  48    */
  49   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const = 0;
  50
  51 public:
  52   // Public methods to work with altitudes.
  53
  54   /**
  55    * Returns altitude points list.
  56    * \return points list
  57    */
  58   HYDRODATA_EXPORT static double            GetInvalidAltitude();
  59
  60   /**
  61    * Returns altitude for given point.
  62    * \param thePoint the point to examine
  63    * \return altitude value
  64    */
  65   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint, int theMethod=0 ) const = 0;
  66
  67
  68 protected:
  69
  70   /**
  71    * Creates new object in the internal data structure. Use higher level objects
  72    * to create objects with real content.
  73    */
  74   HYDRODATA_EXPORT HYDROData_IAltitudeObject();
  75
  76   /**
  77    * Destructs properties of the object and object itself, removes it from the document.
  78    */
  79   HYDRODATA_EXPORT ~HYDROData_IAltitudeObject();
  80 };
  81
  82 #endif