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_Image;
63 sipClass = sipClass_HYDROData_PolylineXY;
67 sipClass = sipClass_HYDROData_Bathymetry;
70 case KIND_IMMERSIBLE_ZONE:
71 sipClass = sipClass_HYDROData_ImmersibleZone;
74 case KIND_CALCULATION:
75 sipClass = sipClass_HYDROData_CalculationCase;
79 sipClass = sipClass_HYDROData_Obstacle;
83 sipClass = sipClass_HYDROData_Region;
87 sipClass = sipClass_HYDROData_Zone;
91 sipClass = sipClass_HYDROData_Entity;
95 // We don't recognise the type.
103 * Returns the kind of this object. Must be redefined in all objects of known type.
105 virtual const ObjectKind GetKind() const;
108 * Returns the name of this object.
110 virtual QString GetName() const;
113 * Updates the name of this object.
115 virtual void SetName(const QString& theName);
118 * Updates object state.
120 virtual void Update();
123 * Checks is object exists in the data structure.
124 * \returns true is object is not exists in the data model
126 bool IsRemoved() const;
129 * Removes object from the data structure.
134 * Returns unique integer identifier of the object (may be used for ordering of objects)
139 * Copies all properties of this to the destinated object.
140 * Objects must be the same type.
141 * \param theDestination initialized object (from any document) - target of copying
144 void CopyTo( HYDROData_Entity theDestination ) const;
148 * Returns the list of all reference objects of this object.
149 * Base implementation always return empty list.
151 virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
156 * Creates new object in the internal data structure. Use higher level objects
157 * to create objects with real content.
162 * Destructs properties of the object and object itself, removes it from the document.
164 virtual ~HYDROData_Entity();