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