src/HYDROPy/HYDROData_Region.sip

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 %ExportedHeaderCode
  24 #include <HYDROData_Region.h>
  25 %End
  26
  27 class HYDROData_Region : HYDROData_Entity
  28 {
  29
  30 %TypeHeaderCode
  31 #include <HYDROData_Region.h>
  32 %End
  33
  34 %ConvertToSubClassCode
  35     switch ( sipCpp->GetKind() )
  36     {
  37       case KIND_REGION:
  38         sipClass = sipClass_HYDROData_Region;
  39         break;
  40
  41       default:
  42         // We don't recognise the type.
  43         sipClass = NULL;
  44     }
  45 %End
  46
  47 public:
  48
  49   // Enumeration of mergin types for conflict bathymetries
  50   enum MergeBathymetriesType
  51   {
  52     Merge_ZMIN,
  53     Merge_ZMAX
  54   };
  55
  56 public:
  57
  58   /**
  59    * Create new one reference zone for region on child label.
  60    * The new zone is not added into the list of reference zones.
  61    */
  62   HYDROData_Zone AddNewZone() [Handle_HYDROData_Zone ()];
  63   %MethodCode
  64
  65     Handle(HYDROData_Zone) aNewZone;
  66
  67     Py_BEGIN_ALLOW_THREADS
  68     aNewZone = sipSelfWasArg ? sipCpp->HYDROData_Region::AddNewZone() :
  69                                sipCpp->AddNewZone();
  70     Py_END_ALLOW_THREADS
  71
  72     sipRes = (HYDROData_Zone*)createPointer( aNewZone );
  73
  74   %End
  75
  76   /**
  77    * Removes all child zones from region.
  78    */
  79   void RemoveChildZones();
  80
  81
  82   /**
  83    * Sets the merging type for conflict bathymetries.
  84    * By default it is set to Merge_ZMIN.
  85    */
  86   void SetMergeType( const MergeBathymetriesType& theType );
  87
  88   /**
  89    * Returns the merging type for conflict bathymetries.
  90    */
  91   MergeBathymetriesType GetMergeType() const;
  92
  93
  94   /**
  95    * Returns number of reference zones of region.
  96    */
  97   int NbZones() const;
  98
  99   /**
 100    * Add new one reference zone for region.
 101    */
 102   void AddZone( HYDROData_Zone theZone ) [void (const Handle_HYDROData_Zone&)];
 103   %MethodCode
 104
 105     Handle(HYDROData_Zone) aZone =
 106       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
 107     if ( !aZone.IsNull() )
 108     {
 109       Py_BEGIN_ALLOW_THREADS
 110       sipSelfWasArg ? sipCpp->HYDROData_Region::AddZone( aZone ) :
 111                       sipCpp->AddZone( aZone );
 112       Py_END_ALLOW_THREADS
 113     }
 114
 115   %End
 116
 117   /**
 118    * Replace the reference zone for region.
 119    */
 120   void SetZone( const int      theIndex,
 121                 HYDROData_Zone theZone ) [void (const int, const Handle_HYDROData_Zone&)];
 122   %MethodCode
 123
 124     Handle(HYDROData_Zone) aZone =
 125       Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
 126     if ( !aZone.IsNull() )
 127     {
 128       Py_BEGIN_ALLOW_THREADS
 129       sipSelfWasArg ? sipCpp->HYDROData_Region::SetZone( a0, aZone ) :
 130                       sipCpp->SetZone( a0, aZone );
 131       Py_END_ALLOW_THREADS
 132     }
 133
 134   %End
 135
 136   /**
 137    * Inserts the reference zone for region before given index.
 138    */
 139   void InsertZone( const int      theBeforeIndex,
 140                    HYDROData_Zone theZone ) [void (const int, const Handle_HYDROData_Zone&)];
 141   %MethodCode
 142
 143     Handle(HYDROData_Zone) aZone =
 144       Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
 145     if ( !aZone.IsNull() )
 146     {
 147       Py_BEGIN_ALLOW_THREADS
 148       sipSelfWasArg ? sipCpp->HYDROData_Region::InsertZone( a0, aZone ) :
 149                       sipCpp->InsertZone( a0, aZone );
 150       Py_END_ALLOW_THREADS
 151     }
 152
 153   %End
 154
 155   /**
 156    * Sets reference zones for calculation region.
 157    */
 158   //void SetZones( const HYDROData_SequenceOfObjects& theZones );
 159
 160   /**
 161    * Returns reference zone of region by index.
 162    */
 163   HYDROData_Zone GetZone( const int theIndex ) const [Handle_HYDROData_Zone (const int)];
 164   %MethodCode
 165
 166     Handle(HYDROData_Zone) aRefZone;
 167
 168     Py_BEGIN_ALLOW_THREADS
 169     aRefZone = sipSelfWasArg ? sipCpp->HYDROData_Region::GetZone( a0 ) :
 170                                sipCpp->GetZone( a0 );
 171     Py_END_ALLOW_THREADS
 172
 173     sipRes = (HYDROData_Zone*)createPointer( aRefZone );
 174
 175   %End
 176
 177   /**
 178    * Returns all reference zone of region.
 179    */
 180   //void HYDROData_SequenceOfObjects GetZones() const;
 181
 182   /**
 183    * Removes reference zone from region.
 184    */
 185   void RemoveZone( HYDROData_Zone theZone ) [void (const Handle_HYDROData_Zone&)];
 186   %MethodCode
 187
 188     Handle(HYDROData_Zone) aZone =
 189       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
 190     if ( !aZone.IsNull() )
 191     {
 192       Py_BEGIN_ALLOW_THREADS
 193       sipSelfWasArg ? sipCpp->HYDROData_Region::RemoveZone( aZone ) :
 194                       sipCpp->RemoveZone( aZone );
 195       Py_END_ALLOW_THREADS
 196     }
 197
 198   %End
 199
 200   /**
 201    * Removes reference zone from region by it index.
 202    */
 203   void RemoveZone( const int theIndex );
 204
 205   /**
 206    * Removes all reference zones from region.
 207    */
 208   void RemoveZones();
 209
 210
 211 protected:
 212
 213   /**
 214    * Creates new object in the internal data structure. Use higher level objects
 215    * to create objects with real content.
 216    */
 217   HYDROData_Region();
 218
 219   /**
 220    * Destructs properties of the object and object itself, removes it from the document.
 221    */
 222   ~HYDROData_Region();
 223 };
 224
 225