Salome HOME
SIP: HYDROData_AltitudeObject is included.
[modules/hydro.git] / src / HYDROPy / HYDROData_AltitudeObject.sip
1 // Copyright (C) 2007-2013  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.
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 %ExportedHeaderCode
24 #include <HYDROData_AltitudeObject.h>
25 %End
26
27 class HYDROData_AltitudeObject : public HYDROData_IAltitudeObject
28 {
29
30 %TypeHeaderCode
31 #include <HYDROData_AltitudeObject.h>
32 %End
33
34 public:      
35
36   // Public methods to work with altitudes.
37
38   /**
39    * Returns altitude for given point.
40    * \param thePoint the point to examine
41    * \return altitude value
42    */
43   virtual double           GetAltitudeForPoint( const gp_XY& thePoint ) const;
44
45 protected:
46
47   /**
48    * Creates new object in the internal data structure. Use higher level objects 
49    * to create objects with real content.
50    */
51   HYDROData_AltitudeObject();
52
53   /**
54    * Destructs properties of the object and object itself, removes it from the document.
55    */
56    ~HYDROData_AltitudeObject();
57 };