]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_ObstacleAltitude.h
Salome HOME
Merge remote-tracking branch 'origin/BR_IMPROVEMENTS' into BR_v14_rc
[modules/hydro.git] / src / HYDROData / HYDROData_ObstacleAltitude.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_ObstacleAltitude_HeaderFile
20 #define HYDROData_ObstacleAltitude_HeaderFile
21
22
23 #include "HYDROData_IAltitudeObject.h"
24
25
26 DEFINE_STANDARD_HANDLE(HYDROData_ObstacleAltitude, HYDROData_IAltitudeObject)
27
28
29 /**\class HYDROData_ObstacleAltitude
30  * \brief Class that stores/retreives information about the obstacle altitude.
31  *
32  */
33 class HYDROData_ObstacleAltitude : public HYDROData_IAltitudeObject
34 {
35 protected:
36
37   /**
38    * Enumeration of tags corresponding to the persistent object parameters.
39    */
40   enum DataTag
41   {
42     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
43   };
44
45 public:
46
47   DEFINE_STANDARD_RTTI(HYDROData_ObstacleAltitude);
48
49   /**
50    * Returns the kind of this object. 
51    */
52   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_OBSTACLE_ALTITUDE; }
53
54 public:      
55
56   // Public methods to work with altitudes.
57
58   /**
59    * Returns altitude for given point.
60    * \param thePoint the point to examine
61    * \return altitude value
62    */
63   HYDRODATA_EXPORT virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
64
65 protected:
66
67   friend class HYDROData_Iterator;
68
69   /**
70    * Creates new object in the internal data structure. Use higher level objects 
71    * to create objects with real content.
72    */
73   HYDRODATA_EXPORT HYDROData_ObstacleAltitude();
74
75   /**
76    * Destructs properties of the object and object itself, removes it from the document.
77    */
78   HYDRODATA_EXPORT  ~HYDROData_ObstacleAltitude();
79 };
80
81 #endif