1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include <HYDROData_Entity.h>
23 typedef int ObjectKind;
25 const ObjectKind KIND_UNKNOWN;
26 const ObjectKind KIND_IMAGE;
27 const ObjectKind KIND_POLYLINE;
28 const ObjectKind KIND_BATHYMETRY;
29 const ObjectKind KIND_ALTITUDE;
30 const ObjectKind KIND_IMMERSIBLE_ZONE;
31 const ObjectKind KIND_RIVER;
32 const ObjectKind KIND_STREAM;
33 const ObjectKind KIND_CONFLUENCE;
34 const ObjectKind KIND_CHANNEL;
35 const ObjectKind KIND_OBSTACLE;
36 const ObjectKind KIND_DIGUE;
37 const ObjectKind KIND_PROFILE;
38 const ObjectKind KIND_PROFILEUZ;
39 const ObjectKind KIND_POLYLINEXY;
40 const ObjectKind KIND_CALCULATION;
41 const ObjectKind KIND_ZONE;
42 const ObjectKind KIND_REGION;
43 const ObjectKind KIND_SHAPES_GROUP;
44 const ObjectKind KIND_SPLITTED_GROUP;
45 const ObjectKind KIND_OBSTACLE_ALTITUDE;
47 class HYDROData_Entity
50 #include <HYDROData_Entity.h>
53 %ConvertToSubClassCode
54 // HYDROData_Entity sub-classes provide a unique kind ID.
55 switch ( sipCpp->GetKind() )
58 sipClass = sipClass_HYDROData_Image;
62 sipClass = sipClass_HYDROData_Polyline3D;
66 sipClass = sipClass_HYDROData_Bathymetry;
70 sipClass = sipClass_HYDROData_AltitudeObject;
73 case KIND_IMMERSIBLE_ZONE:
74 sipClass = sipClass_HYDROData_ImmersibleZone;
78 sipClass = sipClass_HYDROData_River;
82 sipClass = sipClass_HYDROData_Stream;
86 sipClass = sipClass_HYDROData_Confluence;
90 sipClass = sipClass_HYDROData_Channel;
94 sipClass = sipClass_HYDROData_Obstacle;
98 sipClass = sipClass_HYDROData_Digue;
102 sipClass = sipClass_HYDROData_Profile;
106 sipClass = sipClass_HYDROData_ProfileUZ;
109 case KIND_POLYLINEXY:
110 sipClass = sipClass_HYDROData_PolylineXY;
113 case KIND_CALCULATION:
114 sipClass = sipClass_HYDROData_CalculationCase;
118 sipClass = sipClass_HYDROData_Zone;
122 sipClass = sipClass_HYDROData_Region;
125 case KIND_SHAPES_GROUP:
126 sipClass = sipClass_HYDROData_ShapesGroup;
129 case KIND_SPLITTED_GROUP:
130 sipClass = sipClass_HYDROData_SplittedShapesGroup;
133 case KIND_STREAM_ALTITUDE:
134 sipClass = sipClass_HYDROData_StreamAltitude;
137 case KIND_OBSTACLE_ALTITUDE:
138 sipClass = sipClass_HYDROData_ObstacleAltitude;
142 sipClass = sipClass_HYDROData_Entity;
146 // We don't recognise the type.
154 * Returns the kind of this object. Must be redefined in all objects of known type.
156 virtual const ObjectKind GetKind() const;
159 * Returns the name of this object.
161 virtual QString GetName() const;
164 * Updates the name of this object.
166 virtual void SetName(const QString& theName);
169 * Updates object state.
171 virtual void Update();
174 * Checks that object has 2D presentation. Base implementation returns false.
176 virtual bool IsHas2dPrs() const;
179 * Returns data of object wrapped to QVariant.
180 * Base implementation returns null value.
182 virtual QVariant GetDataVariant();
186 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
187 * \param theFlag is true for objects that must be updated, false for up-to-date
189 virtual void SetToUpdate( bool theFlag );
192 * Returns the "MustBeUpdated" flag: is object data must be updated or not
193 * \returns false if object is up to date
195 virtual bool IsMustBeUpdated() const;
198 * Returns flag indicating that object is updateble or not.
200 virtual bool CanBeUpdated() const;
204 * Checks is object exists in the data structure.
205 * \returns true is object is not exists in the data model
207 bool IsRemoved() const;
210 * Removes object from the data structure.
212 virtual void Remove();
216 * Copies all properties of this to the destinated object.
217 * Objects must be the same type.
218 * \param theDestination initialized object (from any document) - target of copying
220 void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
222 Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
223 if ( !aCopyTo.IsNull() )
225 Py_BEGIN_ALLOW_THREADS
226 sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
227 sipCpp->CopyTo( aCopyTo );
233 * Returns father object. For object created under root document label
234 * this method always return NULL object.
236 HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
238 Handle(HYDROData_Entity) aFather;
240 Py_BEGIN_ALLOW_THREADS
241 aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
242 sipCpp->GetFatherObject();
245 sipRes = createPointer( aFather );
249 * Returns the list of all reference objects of this object.
250 * Base implementation always return empty list.
252 virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
256 * Returns the z-level for object presentation, -1 if no z-level.
258 virtual bool GetZLevel( int& theLevel ) const [Standard_Boolean ( Standard_Integer& )];
261 * Set the z-level for object presentation.
263 virtual void SetZLevel( const int& theLevel ) [void ( const Standard_Integer& )];
266 * Remove the z-level of object presentation.
268 virtual void RemoveZLevel();
274 * Creates new object in the internal data structure. Use higher level objects
275 * to create objects with real content.
280 * Destructs properties of the object and object itself, removes it from the document.
282 virtual ~HYDROData_Entity();