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