]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_StreamAltitude.h
Salome HOME
refs #768: local CS change for land covers
[modules/hydro.git] / 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 DEFINE_STANDARD_HANDLE(HYDROData_StreamAltitude, HYDROData_IAltitudeObject)
27
28 class TopoDS_Wire;
29
30 /**\class HYDROData_StreamAltitude
31  * \brief Class that stores/retreives information about the stream altitude.
32  *
33  */
34 class HYDROData_StreamAltitude : public HYDROData_IAltitudeObject
35 {
36 protected:
37
38   /**
39    * Enumeration of tags corresponding to the persistent object parameters.
40    */
41   enum DataTag
42   {
43     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
44   };
45
46 public:
47
48   DEFINE_STANDARD_RTTI(HYDROData_StreamAltitude);
49
50   /**
51    * Returns the kind of this object. 
52    */
53   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_STREAM_ALTITUDE; }
54
55 public:      
56
57   // Public methods to work with altitudes.
58
59   /**
60    * Returns altitude for given point.
61    * \param thePoint the point to examine
62    * \return altitude value
63    */
64   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
65
66 protected:
67
68   bool getBoundaryWiresForPoint( const gp_XY&               thePoint,
69                                  TopoDS_Wire& theLeftWire,
70                                  TopoDS_Wire& theRightWire ) const;
71
72 protected:
73
74   friend class HYDROData_Iterator;
75
76   /**
77    * Creates new object in the internal data structure. Use higher level objects 
78    * to create objects with real content.
79    */
80   HYDRODATA_EXPORT HYDROData_StreamAltitude();
81
82   /**
83    * Destructs properties of the object and object itself, removes it from the document.
84    */
85   HYDRODATA_EXPORT  ~HYDROData_StreamAltitude();
86 };
87
88 #endif