1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 #include <HYDROData_Entity.h>
27 typedef int ObjectKind;
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 const ObjectKind KIND_SHAPES_GROUP;
48 const ObjectKind KIND_SPLITTED_GROUP;
49 const ObjectKind KIND_OBSTACLE_ALTITUDE;
51 class HYDROData_Entity
54 #include <HYDROData_Entity.h>
57 %ConvertToSubClassCode
58 // HYDROData_Entity sub-classes provide a unique kind ID.
59 switch ( sipCpp->GetKind() )
62 sipClass = sipClass_HYDROData_Image;
66 sipClass = sipClass_HYDROData_Polyline3D;
70 sipClass = sipClass_HYDROData_Bathymetry;
74 sipClass = sipClass_HYDROData_AltitudeObject;
77 case KIND_IMMERSIBLE_ZONE:
78 sipClass = sipClass_HYDROData_ImmersibleZone;
82 sipClass = sipClass_HYDROData_River;
86 sipClass = sipClass_HYDROData_Stream;
90 sipClass = sipClass_HYDROData_Confluence;
94 sipClass = sipClass_HYDROData_Channel;
98 sipClass = sipClass_HYDROData_Obstacle;
102 sipClass = sipClass_HYDROData_Digue;
106 sipClass = sipClass_HYDROData_Profile;
110 sipClass = sipClass_HYDROData_ProfileUZ;
113 case KIND_POLYLINEXY:
114 sipClass = sipClass_HYDROData_PolylineXY;
117 case KIND_CALCULATION:
118 sipClass = sipClass_HYDROData_CalculationCase;
122 sipClass = sipClass_HYDROData_Zone;
126 sipClass = sipClass_HYDROData_Region;
129 case KIND_SHAPES_GROUP:
130 sipClass = sipClass_HYDROData_ShapesGroup;
133 case KIND_SPLITTED_GROUP:
134 sipClass = sipClass_HYDROData_SplittedShapesGroup;
137 case KIND_STREAM_ALTITUDE:
138 sipClass = sipClass_HYDROData_StreamAltitude;
141 case KIND_OBSTACLE_ALTITUDE:
142 sipClass = sipClass_HYDROData_ObstacleAltitude;
146 sipClass = sipClass_HYDROData_Entity;
150 // We don't recognise the type.
158 * Returns the kind of this object. Must be redefined in all objects of known type.
160 virtual const ObjectKind GetKind() const;
163 * Returns the name of this object.
165 virtual QString GetName() const;
168 * Updates the name of this object.
170 virtual void SetName(const QString& theName);
173 * Updates object state.
175 virtual void Update();
178 * Checks that object has 2D presentation. Base implementation returns false.
180 virtual bool IsHas2dPrs() const;
183 * Returns data of object wrapped to QVariant.
184 * Base implementation returns null value.
186 virtual QVariant GetDataVariant();
190 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
191 * \param theFlag is true for objects that must be updated, false for up-to-date
193 virtual void SetToUpdate( bool theFlag );
196 * Returns the "MustBeUpdated" flag: is object data must be updated or not
197 * \returns false if object is up to date
199 virtual bool IsMustBeUpdated() const;
202 * Returns flag indicating that object is updateble or not.
204 virtual bool CanBeUpdated() const;
208 * Checks is object exists in the data structure.
209 * \returns true is object is not exists in the data model
211 bool IsRemoved() const;
214 * Removes object from the data structure.
216 virtual void Remove();
220 * Copies all properties of this to the destinated object.
221 * Objects must be the same type.
222 * \param theDestination initialized object (from any document) - target of copying
224 void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
226 Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
227 if ( !aCopyTo.IsNull() )
229 Py_BEGIN_ALLOW_THREADS
230 sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
231 sipCpp->CopyTo( aCopyTo );
237 * Returns father object. For object created under root document label
238 * this method always return NULL object.
240 HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
242 Handle(HYDROData_Entity) aFather;
244 Py_BEGIN_ALLOW_THREADS
245 aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
246 sipCpp->GetFatherObject();
249 sipRes = createPointer( aFather );
253 * Returns the list of all reference objects of this object.
254 * Base implementation always return empty list.
256 virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
260 * Returns the z-level for object presentation, -1 if no z-level.
262 virtual bool GetZLevel( int& theLevel ) const [Standard_Boolean ( Standard_Integer& )];
265 * Set the z-level for object presentation.
267 virtual void SetZLevel( const int& theLevel ) [void ( const Standard_Integer& )];
270 * Remove the z-level of object presentation.
272 virtual void RemoveZLevel();
278 * Creates new object in the internal data structure. Use higher level objects
279 * to create objects with real content.
284 * Destructs properties of the object and object itself, removes it from the document.
286 virtual ~HYDROData_Entity();