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