Parameters annotation corrected.

[modules/hydro.git] / src / HYDROPy / HYDROData_Zone.sip

diff --git a/src/HYDROPy/HYDROData_Zone.sip b/src/HYDROPy/HYDROData_Zone.sip
index 4b28e6d8451b06d6c5b8ac9585623294ac6cda57..5200984b889075dea5a38b543770ff13b8193611 100644 (file)
--- a/src/HYDROPy/HYDROData_Zone.sip
+++ b/src/HYDROPy/HYDROData_Zone.sip
@@ -24,13 +24,9 @@
 #include <HYDROData_Zone.h>
 %End
 
-class HYDROData_Zone : HYDROData_Entity
+class HYDROData_Zone : public HYDROData_Entity
 {
 
-%TypeHeaderCode
-#include <HYDROData_Zone.h>
-%End
-
 %ConvertToSubClassCode
     switch ( sipCpp->GetKind() )
     {
@@ -44,70 +40,74 @@ class HYDROData_Zone : HYDROData_Entity
     }
 %End
 
+%TypeHeaderCode
+#include <HYDROData_Zone.h>
+%End
+
 public:
 
-  // Enumeration of mergin types for conflict bathymetries
-  enum MergeBathymetriesType
+  // Enumeration of mergin types for conflict altitudes
+  enum MergeAltitudesType
   {
     Merge_ZMIN,   // The minimum values
     Merge_ZMAX,   // The maximum values
-    Merge_Object  // Only one bathymetry will be taken into account
+    Merge_Object   // Only one altitude will be taken into account
   };
 
 public:      
 
   /**
-   * Sets the merging type for conflict bathymetries.
+   * Sets the merging type for conflict altitudes.
    * By default it is set to Merge_ZMIN.
    */
-  void SetMergeType( const MergeBathymetriesType& theType );
+  void SetMergeType( const MergeAltitudesType& theType );
 
   /**
-   * Returns the merging type for conflict bathymetries.
+   * Returns the merging type for conflict altitudes.
    */
-  MergeBathymetriesType GetMergeType() const;
+  MergeAltitudesType GetMergeType() const;
 
 
   /**
-   * Sets the reference bathymetry to resolve the conflict.
+   * Sets the reference altitude to resolve the conflict.
    * This object is used only in case of "Merge_Object" merge type.
    */
-  void SetMergeBathymetry( HYDROData_Bathymetry theBathymetry ) [void (const Handle_HYDROData_Bathymetry&)];
+  void SetMergeAltitude( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
   %MethodCode
 
-    Handle(HYDROData_Bathymetry) aRefBath =
-      Handle(HYDROData_Bathymetry)::DownCast( createHandle( a0 ) );
-    if ( !aRefBath.IsNull() )
+    Handle(HYDROData_IAltitudeObject) aRefAltitude =
+      Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
+    if ( !aRefAltitude.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetMergeBathymetry( aRefBath ) : 
-                      sipCpp->SetMergeBathymetry( aRefBath );
+      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetMergeAltitude( aRefAltitude ) : 
+                      sipCpp->SetMergeAltitude( aRefAltitude );
       Py_END_ALLOW_THREADS
     }
 
   %End
 
   /**
-   * Returns the reference bathymetry to resolve the conflict.
+   * Returns the reference altitude to resolve the conflict.
    */
-  HYDROData_Bathymetry GetMergeBathymetry() const [Handle_HYDROData_Bathymetry ()];
+  HYDROData_IAltitudeObject GetMergeAltitude() const [Handle_HYDROData_IAltitudeObject ()];
   %MethodCode
 
-    Handle(HYDROData_Bathymetry) aRefBath;
+    Handle(HYDROData_IAltitudeObject) aRefAltitude;
     
     Py_BEGIN_ALLOW_THREADS
-    aRefBath = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetMergeBathymetry() : 
-                               sipCpp->GetMergeBathymetry();
+    aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetMergeAltitude() : 
+                                   sipCpp->GetMergeAltitude();
     Py_END_ALLOW_THREADS
     
-    sipRes = (HYDROData_Bathymetry*)createPointer( aRefBath );
+    sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
   
   %End
 
   /**
-   * Removes the reference bathymetry for resolving the conflict.
+   * Removes the reference altitude for resolving the conflict.
    */
-  void RemoveMergeBathymetry();
+  void RemoveMergeAltitude();
 
 
   /**
@@ -131,13 +131,27 @@ public:
   /**
    * Returns all geometry objects of zone.
    */
-  //HYDROData_SequenceOfObjects GetGeometryObjects() const;
+  HYDROData_SequenceOfObjects GetGeometryObjects() const;
 
   /**
    * Removes all geometry objects from zone.
    */
   void RemoveGeometryObjects();
 
+
+  /**
+   * Sets the interpolator for zone. By default it is NULL and original
+   * interpolation algorithms are used to calculate points altitudes.
+   * If you set interpolator it won't be stored in the data model structure,
+   * it will be deleted during that time as this zone will be freed.
+   */
+  void SetInterpolator( HYDROData_IInterpolator* theInter );
+
+  /**
+   * * Returns the interpolator of zone object.
+   */
+  HYDROData_IInterpolator* GetInterpolator() const;
+
 protected:
 
   /**