src/HYDROData/HYDROData_ChannelAltitude.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_ChannelAltitude_HeaderFile
  20 #define HYDROData_ChannelAltitude_HeaderFile
  21
  22
  23 #include "HYDROData_IAltitudeObject.h"
  24
  25
  26
  27 /**\class HYDROData_ChannelAltitude
  28  * \brief Class that stores/retrieves information about the Channel altitude.
  29  *
  30  */
  31 class HYDROData_ChannelAltitude : public HYDROData_IAltitudeObject
  32 {
  33 protected:
  34
  35   /**
  36    * Enumeration of tags corresponding to the persistent object parameters.
  37    */
  38   enum DataTag
  39   {
  40     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  41     DataTag_InvertDirection,                                        ///< flag for inversion of direction
  42   };
  43
  44 public:
  45
  46   DEFINE_STANDARD_RTTIEXT(HYDROData_ChannelAltitude, HYDROData_IAltitudeObject);
  47
  48   /**
  49    * Returns the kind of this object.
  50    */
  51   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CHANNEL_ALTITUDE; }
  52
  53 public:
  54
  55   // Public methods to work with altitudes.
  56
  57   /**
  58    * Returns altitude for given point.
  59    * \param thePoint the point to examine
  60    * \return altitude value
  61    */
  62   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint,
  63                                                                  int theMethod =0) const;
  64
  65   HYDRODATA_EXPORT void                     SetInvertDirection(bool IsInverted);
  66
  67   HYDRODATA_EXPORT bool                     GetInvertDirection() const;
  68
  69 protected:
  70
  71   friend class HYDROData_Iterator;
  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_ChannelAltitude();
  78
  79   /**
  80    * Destructs properties of the object and object itself, removes it from the document.
  81    */
  82   HYDRODATA_EXPORT  ~HYDROData_ChannelAltitude();
  83 };
  84
  85 #endif