Salome HOME
SIP: HYDROData_Channel is included.
[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_CHANNEL:
46       sipClass = sipClass_HYDROData_Channel;
47       break;
48       
49     case KIND_POLYLINE:
50       sipClass = sipClass_HYDROData_Polyline3D;
51       break;
52
53     case KIND_PROFILE:
54       sipClass = sipClass_HYDROData_Profile;
55       break;
56
57     case KIND_UNKNOWN:
58       sipClass = sipClass_HYDROData_Entity;
59       break;
60
61     default:
62       // We don't recognise the type.
63       sipClass = NULL;
64   }
65 %End
66
67 public:
68
69   /**
70    * Set reference altitude object for geometry object.
71    */
72   bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
73   %MethodCode
74
75     Handle(HYDROData_IAltitudeObject) aRefAltitude =
76       Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
77     if ( !aRefAltitude.IsNull() )
78     {
79       Py_BEGIN_ALLOW_THREADS
80       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::SetAltitudeObject( aRefAltitude ) : 
81                                sipCpp->SetAltitudeObject( aRefAltitude );
82       Py_END_ALLOW_THREADS
83     }
84
85   %End
86
87   /**
88    * Returns reference altitude object of geometry object.
89    */
90   HYDROData_IAltitudeObject GetAltitudeObject() const [Handle_HYDROData_IAltitudeObject ()];
91   %MethodCode
92
93     Handle(HYDROData_IAltitudeObject) aRefAltitude;
94     
95     Py_BEGIN_ALLOW_THREADS
96     aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Object::GetAltitudeObject() : 
97                                    sipCpp->GetAltitudeObject();
98     Py_END_ALLOW_THREADS
99     
100     sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
101   
102   %End
103
104   /**
105    * Clear the reference altitude object for geometry object.
106    */
107   void RemoveAltitudeObject();
108
109 protected:
110
111   /**
112    * Creates new object in the internal data structure. Use higher level objects 
113    * to create objects with real content.
114    */
115   HYDROData_Object();
116
117   /**
118    * Destructs properties of the object and object itself, removes it from the document.
119    */
120   virtual ~HYDROData_Object();
121   
122 };