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