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_Region.h>
27 class HYDROData_Region : HYDROData_Entity
31 #include <HYDROData_Region.h>
34 %ConvertToSubClassCode
35 switch ( sipCpp->GetKind() )
38 sipClass = sipClass_HYDROData_Region;
42 // We don't recognise the type.
49 // Enumeration of mergin types for conflict bathymetries
50 enum MergeBathymetriesType
59 * Create new one reference zone for region on child label.
60 * The new zone is not added into the list of reference zones.
62 HYDROData_Zone AddNewZone() [Handle_HYDROData_Zone ()];
65 Handle(HYDROData_Zone) aNewZone;
67 Py_BEGIN_ALLOW_THREADS
68 aNewZone = sipSelfWasArg ? sipCpp->HYDROData_Region::AddNewZone() :
72 sipRes = (HYDROData_Zone*)createPointer( aNewZone );
77 * Removes all child zones from region.
79 void RemoveChildZones();
83 * Sets the merging type for conflict bathymetries.
84 * By default it is set to Merge_ZMIN.
86 void SetMergeType( const MergeBathymetriesType& theType );
89 * Returns the merging type for conflict bathymetries.
91 MergeBathymetriesType GetMergeType() const;
95 * Returns number of reference zones of region.
100 * Add new one reference zone for region.
102 void AddZone( HYDROData_Zone theZone ) [void (const Handle_HYDROData_Zone&)];
105 Handle(HYDROData_Zone) aZone =
106 Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
107 if ( !aZone.IsNull() )
109 Py_BEGIN_ALLOW_THREADS
110 sipSelfWasArg ? sipCpp->HYDROData_Region::AddZone( aZone ) :
111 sipCpp->AddZone( aZone );
118 * Replace the reference zone for region.
120 void SetZone( const int theIndex,
121 HYDROData_Zone theZone ) [void (const int, const Handle_HYDROData_Zone&)];
124 Handle(HYDROData_Zone) aZone =
125 Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
126 if ( !aZone.IsNull() )
128 Py_BEGIN_ALLOW_THREADS
129 sipSelfWasArg ? sipCpp->HYDROData_Region::SetZone( a0, aZone ) :
130 sipCpp->SetZone( a0, aZone );
137 * Inserts the reference zone for region before given index.
139 void InsertZone( const int theBeforeIndex,
140 HYDROData_Zone theZone ) [void (const int, const Handle_HYDROData_Zone&)];
143 Handle(HYDROData_Zone) aZone =
144 Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
145 if ( !aZone.IsNull() )
147 Py_BEGIN_ALLOW_THREADS
148 sipSelfWasArg ? sipCpp->HYDROData_Region::InsertZone( a0, aZone ) :
149 sipCpp->InsertZone( a0, aZone );
156 * Sets reference zones for calculation region.
158 //void SetZones( const HYDROData_SequenceOfObjects& theZones );
161 * Returns reference zone of region by index.
163 HYDROData_Zone GetZone( const int theIndex ) const [Handle_HYDROData_Zone (const int)];
166 Handle(HYDROData_Zone) aRefZone;
168 Py_BEGIN_ALLOW_THREADS
169 aRefZone = sipSelfWasArg ? sipCpp->HYDROData_Region::GetZone( a0 ) :
170 sipCpp->GetZone( a0 );
173 sipRes = (HYDROData_Zone*)createPointer( aRefZone );
178 * Returns all reference zone of region.
180 //void HYDROData_SequenceOfObjects GetZones() const;
183 * Removes reference zone from region.
185 void RemoveZone( HYDROData_Zone theZone ) [void (const Handle_HYDROData_Zone&)];
188 Handle(HYDROData_Zone) aZone =
189 Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
190 if ( !aZone.IsNull() )
192 Py_BEGIN_ALLOW_THREADS
193 sipSelfWasArg ? sipCpp->HYDROData_Region::RemoveZone( aZone ) :
194 sipCpp->RemoveZone( aZone );
201 * Removes reference zone from region by it index.
203 void RemoveZone( const int theIndex );
206 * Removes all reference zones from region.
214 * Creates new object in the internal data structure. Use higher level objects
215 * to create objects with real content.
220 * Destructs properties of the object and object itself, removes it from the document.