]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_ChannelAltitude.h
Salome HOME
Merge branch 'BR_H2018_2' of https://codev-tuleap.cea.fr/plugins/git/salome/hydro...
[modules/hydro.git] / 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   };
42
43 public:
44
45   DEFINE_STANDARD_RTTIEXT(HYDROData_ChannelAltitude, HYDROData_IAltitudeObject);
46
47   /**
48    * Returns the kind of this object. 
49    */
50   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CHANNEL_ALTITUDE; }
51
52 public:      
53
54   // Public methods to work with altitudes.
55
56   /**
57    * Returns altitude for given point.
58    * \param thePoint the point to examine
59    * \return altitude value
60    */
61   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint,
62                                                                  int theMethod =0) const;
63
64 protected:
65
66   friend class HYDROData_Iterator;
67
68   /**
69    * Creates new object in the internal data structure. Use higher level objects 
70    * to create objects with real content.
71    */
72   HYDRODATA_EXPORT HYDROData_ChannelAltitude();
73
74   /**
75    * Destructs properties of the object and object itself, removes it from the document.
76    */
77   HYDRODATA_EXPORT  ~HYDROData_ChannelAltitude();
78 };
79
80 #endif