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;
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_AltitudeObject;
63 sipClass = sipClass_HYDROData_Image;
67 sipClass = sipClass_HYDROData_PolylineXY;
71 sipClass = sipClass_HYDROData_ProfileUZ;
75 sipClass = sipClass_HYDROData_Bathymetry;
78 case KIND_OBSTACLE_ALTITUDE:
79 sipClass = sipClass_HYDROData_ObstacleAltitude;
83 sipClass = sipClass_HYDROData_Confluence;
86 case KIND_IMMERSIBLE_ZONE:
87 sipClass = sipClass_HYDROData_ImmersibleZone;
91 sipClass = sipClass_HYDROData_Digue;
95 sipClass = sipClass_HYDROData_Channel;
98 case KIND_CALCULATION:
99 sipClass = sipClass_HYDROData_CalculationCase;
103 sipClass = sipClass_HYDROData_Obstacle;
107 sipClass = sipClass_HYDROData_Polyline3D;
111 sipClass = sipClass_HYDROData_Profile;
115 sipClass = sipClass_HYDROData_Region;
119 sipClass = sipClass_HYDROData_Stream;
123 sipClass = sipClass_HYDROData_Zone;
126 case KIND_SHAPES_GROUP:
127 sipClass = sipClass_HYDROData_ShapesGroup;
130 case KIND_SPLITTED_GROUP:
131 sipClass = sipClass_HYDROData_SplittedShapesGroup;
135 sipClass = sipClass_HYDROData_Entity;
139 // We don't recognise the type.
147 * Returns the kind of this object. Must be redefined in all objects of known type.
149 virtual const ObjectKind GetKind() const;
152 * Returns the name of this object.
154 virtual QString GetName() const;
157 * Updates the name of this object.
159 virtual void SetName(const QString& theName);
162 * Updates object state.
164 virtual void Update();
167 * Returns data of object wrapped to QVariant.
168 * Base implementation returns null value.
170 virtual QVariant GetDataVariant();
174 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
175 * \param theFlag is true for objects that must be updated, false for up-to-date
177 virtual void SetToUpdate( bool theFlag );
180 * Returns the "MustBeUpdated" flag: is object data must be updated or not
181 * \returns false if object is up to date
183 virtual bool IsMustBeUpdated() const;
186 * Returns flag indicating that object is updateble or not.
188 virtual bool CanBeUpdated() const;
192 * Checks is object exists in the data structure.
193 * \returns true is object is not exists in the data model
195 bool IsRemoved() const;
198 * Removes object from the data structure.
200 virtual void Remove();
204 * Copies all properties of this to the destinated object.
205 * Objects must be the same type.
206 * \param theDestination initialized object (from any document) - target of copying
208 void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
210 Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
211 if ( !aCopyTo.IsNull() )
213 Py_BEGIN_ALLOW_THREADS
214 sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
215 sipCpp->CopyTo( aCopyTo );
221 * Returns father object. For object created under root document label
222 * this method always return NULL object.
224 HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
226 Handle(HYDROData_Entity) aFather;
228 Py_BEGIN_ALLOW_THREADS
229 aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
230 sipCpp->GetFatherObject();
233 sipRes = createPointer( aFather );
237 * Returns the list of all reference objects of this object.
238 * Base implementation always return empty list.
240 virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
245 * Creates new object in the internal data structure. Use higher level objects
246 * to create objects with real content.
251 * Destructs properties of the object and object itself, removes it from the document.
253 virtual ~HYDROData_Entity();