Salome HOME
copyrights in HYDRO files are updated
[modules/hydro.git] / src / HYDROPy / HYDROData_Zone.sip
index e70baae0e675e3027ea0f6e301355abc9089e74b..b3eb9bac5bee845f0238240d2f77766b16e13c65 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -6,7 +6,7 @@
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 #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,81 +40,117 @@ class HYDROData_Zone : HYDROData_Entity
     }
 %End
 
+%TypeHeaderCode
+#include <HYDROData_Zone.h>
+%End
+
+public:
+
+  // Enumeration of mergin types for conflict altitudes
+  enum MergeAltitudesType
+  {
+    Merge_ZMIN,   // The minimum values
+    Merge_ZMAX,   // The maximum values
+    Merge_Object   // Only one altitude will be taken into account
+  };
+
 public:      
 
   /**
-   * Returns number of geometry objects for zone.
+   * Sets the merging type for conflict altitudes.
+   * By default it is set to Merge_ZMIN.
    */
-  int NbGeometryObjects() const;
+  void SetMergeType( const MergeAltitudesType& theType );
 
   /**
-   * dd new one geometry object for zone.
+   * Returns the merging type for conflict altitudes.
    */
-  void AddGeometryObject( HYDROData_Object theRegion ) [void (const Handle_HYDROData_Object&)];
+  MergeAltitudesType GetMergeType() const;
+
+
+  /**
+   * Sets the reference altitude to resolve the conflict.
+   * This object is used only in case of "Merge_Object" merge type.
+   */
+  void SetMergeAltitude( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
   %MethodCode
 
-    Handle(HYDROData_Object) aGeomObj =
-      Handle(HYDROData_Object)::DownCast( createHandle( a0 ) );
-    if ( !aGeomObj.IsNull() )
+    Handle(HYDROData_IAltitudeObject) aRefAltitude =
+      Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
+    if ( !aRefAltitude.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      sipSelfWasArg ? sipCpp->HYDROData_Zone::AddGeometryObject( aGeomObj ) : 
-                      sipCpp->AddGeometryObject( aGeomObj );
+      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetMergeAltitude( aRefAltitude ) : 
+                      sipCpp->SetMergeAltitude( aRefAltitude );
       Py_END_ALLOW_THREADS
     }
 
   %End
 
   /**
-   * Replace the geometry object for zone.
+   * Returns the reference altitude to resolve the conflict.
+   */
+  HYDROData_IAltitudeObject GetMergeAltitude() const [Handle_HYDROData_IAltitudeObject ()];
+  %MethodCode
+
+    Handle(HYDROData_IAltitudeObject) aRefAltitude;
+    
+    Py_BEGIN_ALLOW_THREADS
+    aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetMergeAltitude() : 
+                                   sipCpp->GetMergeAltitude();
+    Py_END_ALLOW_THREADS
+    
+    sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
+  
+  %End
+
+  /**
+   * Removes the reference altitude for resolving the conflict.
+   */
+  void RemoveMergeAltitude();
+
+
+  /**
+   * dd new one geometry object for zone.
    */
-  void SetGeometryObject( const int        theIndex, 
-                          HYDROData_Object theObject ) [void (const int, const Handle_HYDROData_Object&)];
+  void AddGeometryObject( HYDROData_Object theRegion ) [void (const Handle_HYDROData_Object&)];
   %MethodCode
 
     Handle(HYDROData_Object) aGeomObj =
-      Handle(HYDROData_Object)::DownCast( createHandle( a1 ) );
+      Handle(HYDROData_Object)::DownCast( createHandle( a0 ) );
     if ( !aGeomObj.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetGeometryObject( a0, aGeomObj ) : 
-                      sipCpp->SetGeometryObject( a0, aGeomObj );
+      sipSelfWasArg ? sipCpp->HYDROData_Zone::AddGeometryObject( aGeomObj ) : 
+                      sipCpp->AddGeometryObject( aGeomObj );
       Py_END_ALLOW_THREADS
     }
 
   %End
 
   /**
-   * Sets the geometry object for zone.
+   * Returns all geometry objects of zone.
    */
-  //void SetGeometryObjects( const HYDROData_SequenceOfObjects& theObjects );
+  HYDROData_SequenceOfObjects GetGeometryObjects() const;
 
   /**
-   * Returns geometry object of zone by index.
+   * Removes all geometry objects from zone.
    */
-  HYDROData_Object GetGeometryObject( const int theIndex ) const [Handle_HYDROData_Object (const int)];
-  %MethodCode
+  void RemoveGeometryObjects();
 
-    Handle(HYDROData_Object) aGeomObj;
-    
-    Py_BEGIN_ALLOW_THREADS
-    aGeomObj = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetGeometryObject( a0 ) : 
-                               sipCpp->GetGeometryObject( a0 );
-    Py_END_ALLOW_THREADS
-    
-    sipRes = (HYDROData_Object*)createPointer( aGeomObj );
-  
-  %End
 
   /**
-   * Returns all geometry objects of zone.
+   * 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.
    */
-  //HYDROData_SequenceOfObjects GetGeometryObjects() const;
+  void SetInterpolator( HYDROData_IInterpolator* theInter );
 
   /**
-   * Removes all geometry objects from zone.
+   * * Returns the interpolator of zone object.
    */
-  void RemoveGeometryObjects();
+  HYDROData_IInterpolator* GetInterpolator() const;
 
 protected: