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;
46 const ObjectKind KIND_STRICKLER_TABLE;
48 class HYDROData_Entity
51 #include <HYDROData_Entity.h>
54 %ConvertToSubClassCode
55 // HYDROData_Entity sub-classes provide a unique kind ID.
56 switch ( sipCpp->GetKind() )
59 sipClass = sipClass_HYDROData_Image;
63 sipClass = sipClass_HYDROData_Polyline3D;
67 sipClass = sipClass_HYDROData_Bathymetry;
71 sipClass = sipClass_HYDROData_AltitudeObject;
74 case KIND_IMMERSIBLE_ZONE:
75 sipClass = sipClass_HYDROData_ImmersibleZone;
79 sipClass = sipClass_HYDROData_River;
83 sipClass = sipClass_HYDROData_Stream;
87 sipClass = sipClass_HYDROData_Confluence;
91 sipClass = sipClass_HYDROData_Channel;
95 sipClass = sipClass_HYDROData_Obstacle;
99 sipClass = sipClass_HYDROData_Digue;
103 sipClass = sipClass_HYDROData_Profile;
107 sipClass = sipClass_HYDROData_ProfileUZ;
110 case KIND_POLYLINEXY:
111 sipClass = sipClass_HYDROData_PolylineXY;
114 case KIND_CALCULATION:
115 sipClass = sipClass_HYDROData_CalculationCase;
119 sipClass = sipClass_HYDROData_Zone;
123 sipClass = sipClass_HYDROData_Region;
126 case KIND_SHAPES_GROUP:
127 sipClass = sipClass_HYDROData_ShapesGroup;
130 case KIND_SPLITTED_GROUP:
131 sipClass = sipClass_HYDROData_SplittedShapesGroup;
134 case KIND_STREAM_ALTITUDE:
135 sipClass = sipClass_HYDROData_StreamAltitude;
138 case KIND_OBSTACLE_ALTITUDE:
139 sipClass = sipClass_HYDROData_ObstacleAltitude;
142 case KIND_STRICKLER_TABLE:
143 sipClass = sipClass_HYDROData_StricklerTable;
147 sipClass = sipClass_HYDROData_Entity;
151 // We don't recognise the type.
159 * Returns the kind of this object. Must be redefined in all objects of known type.
161 virtual const ObjectKind GetKind() const;
164 * Returns the name of this object.
166 virtual QString GetName() const;
169 * Updates the name of this object.
171 virtual void SetName(const QString& theName);
174 * Updates object state.
176 virtual void Update();
179 * Checks that object has 2D presentation. Base implementation returns false.
181 virtual bool IsHas2dPrs() const;
184 * Returns data of object wrapped to QVariant.
185 * Base implementation returns null value.
187 virtual QVariant GetDataVariant();
191 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
192 * \param theFlag is true for objects that must be updated, false for up-to-date
194 virtual void SetToUpdate( bool theFlag );
197 * Returns the "MustBeUpdated" flag: is object data must be updated or not
198 * \returns false if object is up to date
200 virtual bool IsMustBeUpdated() const;
203 * Returns flag indicating that object is updateble or not.
205 virtual bool CanBeUpdated() const;
209 * Checks is object exists in the data structure.
210 * \returns true is object is not exists in the data model
212 bool IsRemoved() const;
215 * Removes object from the data structure.
217 virtual void Remove();
221 * Copies all properties of this to the destinated object.
222 * Objects must be the same type.
223 * \param theDestination initialized object (from any document) - target of copying
225 void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
227 Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
228 if ( !aCopyTo.IsNull() )
230 Py_BEGIN_ALLOW_THREADS
231 sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
232 sipCpp->CopyTo( aCopyTo );
238 * Returns father object. For object created under root document label
239 * this method always return NULL object.
241 HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
243 Handle(HYDROData_Entity) aFather;
245 Py_BEGIN_ALLOW_THREADS
246 aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
247 sipCpp->GetFatherObject();
250 sipRes = createPointer( aFather );
254 * Returns the list of all reference objects of this object.
255 * Base implementation always return empty list.
257 virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
261 * Returns the z-level for object presentation, -1 if no z-level.
263 virtual bool GetZLevel( int& theLevel ) const [Standard_Boolean ( Standard_Integer& )];
266 * Set the z-level for object presentation.
268 virtual void SetZLevel( const int& theLevel ) [void ( const Standard_Integer& )];
271 * Remove the z-level of object presentation.
273 virtual void RemoveZLevel();
279 * Creates new object in the internal data structure. Use higher level objects
280 * to create objects with real content.
285 * Destructs properties of the object and object itself, removes it from the document.
287 virtual ~HYDROData_Entity();