Salome HOME
SIP: HYDROData_SplittedShapesGroup is included.
[modules/hydro.git] / src / HYDROPy / HYDROData_Entity.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_Entity.h>
25 %End
26
27 typedef int ObjectKind;
28
29 const ObjectKind KIND_UNKNOWN;
30 const ObjectKind KIND_IMAGE;
31 const ObjectKind KIND_POLYLINE;
32 const ObjectKind KIND_BATHYMETRY;
33 const ObjectKind KIND_ALTITUDE;
34 const ObjectKind KIND_IMMERSIBLE_ZONE;
35 const ObjectKind KIND_RIVER;
36 const ObjectKind KIND_STREAM;
37 const ObjectKind KIND_CONFLUENCE;
38 const ObjectKind KIND_CHANNEL;
39 const ObjectKind KIND_OBSTACLE;
40 const ObjectKind KIND_DIGUE;
41 const ObjectKind KIND_PROFILE;
42 const ObjectKind KIND_PROFILEUZ;
43 const ObjectKind KIND_POLYLINEXY;
44 const ObjectKind KIND_CALCULATION;
45 const ObjectKind KIND_ZONE;
46 const ObjectKind KIND_REGION;
47
48 class HYDROData_Entity
49 {
50 %TypeHeaderCode
51 #include <HYDROData_Entity.h>
52 %End
53
54 %ConvertToSubClassCode
55     // HYDROData_Entity sub-classes provide a unique kind ID.
56     switch ( sipCpp->GetKind() )
57     {
58       case KIND_ALTITUDE:
59         sipClass = sipClass_HYDROData_AltitudeObject;
60         break;
61       
62       case KIND_IMAGE:
63         sipClass = sipClass_HYDROData_Image;
64         break;
65
66       case KIND_POLYLINEXY:
67         sipClass = sipClass_HYDROData_PolylineXY;
68         break;
69
70       case KIND_PROFILEUZ:
71         sipClass = sipClass_HYDROData_ProfileUZ;
72         break;
73
74       case KIND_BATHYMETRY:
75         sipClass = sipClass_HYDROData_Bathymetry;
76         break;
77
78       case KIND_OBSTACLE_ALTITUDE:
79         sipClass = sipClass_HYDROData_ObstacleAltitude;
80         break;
81
82       case KIND_IMMERSIBLE_ZONE:
83         sipClass = sipClass_HYDROData_ImmersibleZone;
84         break;
85         
86       case KIND_DIGUE:
87         sipClass = sipClass_HYDROData_Digue;
88         break;
89
90       case KIND_CHANNEL:
91         sipClass = sipClass_HYDROData_Channel;
92         break;
93       
94       case KIND_CALCULATION:
95         sipClass = sipClass_HYDROData_CalculationCase;
96         break;
97
98       case KIND_OBSTACLE:
99         sipClass = sipClass_HYDROData_Obstacle;
100         break;
101
102       case KIND_POLYLINE:
103         sipClass = sipClass_HYDROData_Polyline3D;
104         break;
105
106       case KIND_PROFILE:
107         sipClass = sipClass_HYDROData_Profile;
108         break;
109
110       case KIND_REGION:
111         sipClass = sipClass_HYDROData_Region;
112         break;
113
114       case KIND_STREAM:
115         sipClass = sipClass_HYDROData_Stream;
116         break;
117
118       case KIND_ZONE:
119         sipClass = sipClass_HYDROData_Zone;
120         break;
121
122       case KIND_SHAPES_GROUP:
123         sipClass = sipClass_HYDROData_ShapesGroup;
124         break;
125         
126       case KIND_SPLITTED_GROUP:
127         sipClass = sipClass_HYDROData_SplittedShapesGroup;
128         break;
129
130       case KIND_UNKNOWN:
131         sipClass = sipClass_HYDROData_Entity;
132         break;
133
134       default:
135         // We don't recognise the type.
136         sipClass = NULL;
137     }
138 %End
139
140 public:
141
142   /**
143    * Returns the kind of this object. Must be redefined in all objects of known type.
144    */
145   virtual const ObjectKind GetKind() const;
146
147   /**
148    * Returns the name of this object.
149    */
150   virtual QString GetName() const;
151
152   /**
153    * Updates the name of this object.
154    */
155   virtual void SetName(const QString& theName);
156
157   /**
158    * Updates object state.
159    */
160   virtual void Update();
161
162   /**
163    * Returns data of object wrapped to QVariant.
164    * Base implementation returns null value.
165    */
166   virtual QVariant GetDataVariant();
167
168
169   /**
170    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
171    * \param theFlag is true for objects that must be updated, false for up-to-date
172    */
173   virtual void SetToUpdate( bool theFlag );
174
175   /**
176    * Returns the "MustBeUpdated" flag: is object data must be updated or not
177    * \returns false if object is up to date
178    */
179   virtual bool IsMustBeUpdated() const;
180
181   /**
182    * Returns flag indicating that object is updateble or not.
183    */
184   virtual bool CanBeUpdated() const;
185
186   
187   /**
188    * Checks is object exists in the data structure.
189    * \returns true is object is not exists in the data model
190    */
191   bool IsRemoved() const;
192
193   /**
194    * Removes object from the data structure.
195    */
196   virtual void Remove();
197
198
199   /**
200    * Copies all properties of this to the destinated object.
201    * Objects must be the same type.
202    * \param theDestination initialized object (from any document) - target of copying
203    */
204   void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
205   %MethodCode
206     Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
207     if ( !aCopyTo.IsNull() )
208     {
209       Py_BEGIN_ALLOW_THREADS
210       sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
211                       sipCpp->CopyTo( aCopyTo );
212       Py_END_ALLOW_THREADS
213     }
214   %End
215
216   /**
217    * Returns father object. For object created under root document label
218    * this method always return NULL object.
219    */
220   HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
221   %MethodCode
222     Handle(HYDROData_Entity) aFather;
223     
224     Py_BEGIN_ALLOW_THREADS
225     aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() : 
226                               sipCpp->GetFatherObject();
227     Py_END_ALLOW_THREADS
228     
229     sipRes = createPointer( aFather );
230   %End
231
232   /**
233    * Returns the list of all reference objects of this object.
234    * Base implementation always return empty list.
235    */
236   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
237
238 protected:
239
240   /**
241    * Creates new object in the internal data structure. Use higher level objects 
242    * to create objects with real content.
243    */
244   HYDROData_Entity();
245
246   /**
247    * Destructs properties of the object and object itself, removes it from the document.
248    */
249   virtual ~HYDROData_Entity();
250   
251 };