src/HYDROData/HYDROData_StreamAltitude.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_StreamAltitude_HeaderFile
  20 #define HYDROData_StreamAltitude_HeaderFile
  21
  22
  23 #include "HYDROData_IAltitudeObject.h"
  24
  25
  26 class TopoDS_Wire;
  27
  28 /**\class HYDROData_StreamAltitude
  29  * \brief Class that stores/retreives information about the stream altitude.
  30  *
  31  */
  32 class HYDROData_StreamAltitude : public HYDROData_IAltitudeObject
  33 {
  34 protected:
  35
  36   /**
  37    * Enumeration of tags corresponding to the persistent object parameters.
  38    */
  39   enum DataTag
  40   {
  41     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
  42   };
  43
  44 public:
  45
  46   DEFINE_STANDARD_RTTIEXT(HYDROData_StreamAltitude, HYDROData_IAltitudeObject);
  47
  48   /**
  49    * Returns the kind of this object.
  50    */
  51   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_STREAM_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 protected:
  66
  67   bool getBoundaryWiresForPoint( const gp_XY&               thePoint,
  68                                  TopoDS_Wire& theLeftWire,
  69                                  TopoDS_Wire& theRightWire ) const;
  70
  71 protected:
  72
  73   friend class HYDROData_Iterator;
  74
  75   /**
  76    * Creates new object in the internal data structure. Use higher level objects
  77    * to create objects with real content.
  78    */
  79   HYDRODATA_EXPORT HYDROData_StreamAltitude();
  80
  81   /**
  82    * Destructs properties of the object and object itself, removes it from the document.
  83    */
  84   HYDRODATA_EXPORT  ~HYDROData_StreamAltitude();
  85 };
  86
  87 #endif