src/HYDROData/HYDROData_StreamAltitude.h

   1 // Copyright (C) 2007-2015  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, or (at your option) any later version.
  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 #ifndef HYDROData_StreamAltitude_HeaderFile
  24 #define HYDROData_StreamAltitude_HeaderFile
  25
  26
  27 #include "HYDROData_IAltitudeObject.h"
  28
  29 class Handle(HYDROData_Profile);
  30
  31 DEFINE_STANDARD_HANDLE(HYDROData_StreamAltitude, HYDROData_IAltitudeObject)
  32
  33
  34 /**\class HYDROData_StreamAltitude
  35  * \brief Class that stores/retreives information about the stream altitude.
  36  *
  37  */
  38 class HYDROData_StreamAltitude : public HYDROData_IAltitudeObject
  39 {
  40 protected:
  41
  42   /**
  43    * Enumeration of tags corresponding to the persistent object parameters.
  44    */
  45   enum DataTag
  46   {
  47     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  48   };
  49
  50 public:
  51
  52   DEFINE_STANDARD_RTTI(HYDROData_StreamAltitude);
  53
  54   /**
  55    * Returns the kind of this object.
  56    */
  57   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_STREAM_ALTITUDE; }
  58
  59 public:
  60
  61   // Public methods to work with altitudes.
  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;
  69
  70 protected:
  71
  72   bool getBoundaryProfilesForPoint( const gp_XY&               thePoint,
  73                                     Handle(HYDROData_Profile)& theLeftProfile,
  74                                     Handle(HYDROData_Profile)& theRightProfile ) const;
  75
  76 protected:
  77
  78   friend class HYDROData_Iterator;
  79
  80   /**
  81    * Creates new object in the internal data structure. Use higher level objects
  82    * to create objects with real content.
  83    */
  84   HYDRODATA_EXPORT HYDROData_StreamAltitude();
  85
  86   /**
  87    * Destructs properties of the object and object itself, removes it from the document.
  88    */
  89   HYDRODATA_EXPORT  ~HYDROData_StreamAltitude();
  90 };
  91
  92 #endif