Salome HOME
Python module name corrected.
[modules/hydro.git] / src / HYDROPy / HYDROData_Object.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_Object.h>
25 %End
26
27 class HYDROData_Object : HYDROData_Entity /Abstract/
28 {
29 %TypeHeaderCode
30 #include <HYDROData_Object.h>
31 %End
32
33 %ConvertToSubClassCode
34    // HYDROData_Object sub-classes provide a unique kind ID.
35   switch ( sipCpp->GetKind() )
36   {
37     case KIND_OBSTACLE:
38       sipClass = sipClass_HYDROData_Obstacle;
39       break;
40
41     case KIND_IMMERSIBLE_ZONE:
42       sipClass = sipClass_HYDROData_ImmersibleZone;
43       break;
44
45     case KIND_UNKNOWN:
46       sipClass = sipClass_HYDROData_Entity;
47       break;
48
49     default:
50       // We don't recognise the type.
51       sipClass = NULL;
52   }
53 %End
54
55 public:
56
57   /**
58    * Set reference altitude object for geometry object.
59    */
60   bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
61   %MethodCode
62
63     Handle(HYDROData_IAltitudeObject) aRefAltitude =
64       Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
65     if ( !aRefAltitude.IsNull() )
66     {
67       Py_BEGIN_ALLOW_THREADS
68       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::SetAltitudeObject( aRefAltitude ) : 
69                                sipCpp->SetAltitudeObject( aRefAltitude );
70       Py_END_ALLOW_THREADS
71     }
72
73   %End
74
75   /**
76    * Returns reference altitude object of geometry object.
77    */
78   HYDROData_IAltitudeObject GetAltitudeObject() const [Handle_HYDROData_IAltitudeObject ()];
79   %MethodCode
80
81     Handle(HYDROData_IAltitudeObject) aRefAltitude;
82     
83     Py_BEGIN_ALLOW_THREADS
84     aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Object::GetAltitudeObject() : 
85                                    sipCpp->GetAltitudeObject();
86     Py_END_ALLOW_THREADS
87     
88     sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
89   
90   %End
91
92   /**
93    * Clear the reference altitude object for geometry object.
94    */
95   void RemoveAltitudeObject();
96
97 protected:
98
99   /**
100    * Creates new object in the internal data structure. Use higher level objects 
101    * to create objects with real content.
102    */
103   HYDROData_Object();
104
105   /**
106    * Destructs properties of the object and object itself, removes it from the document.
107    */
108   virtual ~HYDROData_Object();
109   
110 };