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