Salome HOME
Merge remote-tracking branch 'origin/BR_SHAPE_RECOGNITION' into BR_v14_rc
[modules/hydro.git] / src / HYDROPy / HYDROData_Zone.sip
index c7c4bb7e7818cd75367ec5a300b96de705bc26ee..6a1aba28ab0d6c335952f1ad40e48a0f089eae92 100644 (file)
@@ -1,12 +1,8 @@
-// Copyright (C) 2007-2013  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
-//
+// Copyright (C) 2014-2015  EDF-R&D
 // 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_Domain
+class HYDROData_Zone : public HYDROData_Entity
 {
 
-%TypeHeaderCode
-#include <HYDROData_Zone.h>
+%ConvertToSubClassCode
+    switch ( sipCpp->GetKind() )
+    {
+      case KIND_ZONE:
+        sipClass = sipClass_HYDROData_Zone;
+        break;
+
+      default:
+        // We don't recognise the type.
+        sipClass = NULL;
+    }
 %End
 
-%ConvertToSubClassCode
-    if ( !Handle(HYDROData_Zone)::DownCast( sipCpp ).IsNull() )
-      sipClass = sipClass_HYDROData_Zone;
-    else
-      sipClass = NULL;
+%TypeHeaderCode
+#include <HYDROData_Zone.h>
 %End
 
 public:
 
-  const ObjectKind          GetKind() const;
+  // 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:      
 
   /**
-   * Sets reference polyline object for zone.
+   * Sets the merging type for conflict altitudes.
+   * By default it is set to Merge_ZMIN.
+   */
+  void SetMergeType( const MergeAltitudesType& theType );
+
+  /**
+   * Returns the merging type for conflict altitudes.
+   */
+  MergeAltitudesType GetMergeType() const;
+
+
+  /**
+   * Sets the reference altitude to resolve the conflict.
+   * This object is used only in case of "Merge_Object" merge type.
    */
-  void SetPolyline( HYDROData_Polyline thePolyline ) [void (const Handle_HYDROData_Polyline&)];
+  void SetMergeAltitude( HYDROData_IAltitudeObject theAltitude ) [void (const Handle_HYDROData_IAltitudeObject&)];
   %MethodCode
 
-    Handle(HYDROData_Polyline) aRefPolyline =
-      Handle(HYDROData_Polyline)::DownCast( createHandle( a0 ) );
-    if ( !aRefPolyline.IsNull() )
+    Handle(HYDROData_IAltitudeObject) aRefAltitude =
+      Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
+    if ( !aRefAltitude.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetPolyline( aRefPolyline ) : 
-                      sipCpp->SetPolyline( aRefPolyline );
+      sipSelfWasArg ? sipCpp->HYDROData_Zone::SetMergeAltitude( aRefAltitude ) : 
+                      sipCpp->SetMergeAltitude( aRefAltitude );
       Py_END_ALLOW_THREADS
     }
 
   %End
 
   /**
-   * Returns reference polyline object of zone.
+   * Returns the reference altitude to resolve the conflict.
    */
-  HYDROData_Polyline GetPolyline() const [Handle_HYDROData_Polyline ()];
+  HYDROData_IAltitudeObject GetMergeAltitude() const [Handle_HYDROData_IAltitudeObject ()];
   %MethodCode
 
-    Handle(HYDROData_Polyline) aRefPolyline;
+    Handle(HYDROData_IAltitudeObject) aRefAltitude;
     
     Py_BEGIN_ALLOW_THREADS
-    aRefPolyline = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetPolyline() : 
-                                   sipCpp->GetPolyline();
+    aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Zone::GetMergeAltitude() : 
+                                   sipCpp->GetMergeAltitude();
     Py_END_ALLOW_THREADS
     
-    sipRes = (HYDROData_Polyline*)createPointer( aRefPolyline );
+    sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
   
   %End
 
   /**
-   * Remove reference polyline object of zone.
+   * Removes the reference altitude for resolving the conflict.
+   */
+  void RemoveMergeAltitude();
+
+
+  /**
+   * dd new one geometry object for zone.
+   */
+  void AddGeometryObject( HYDROData_Object theRegion ) [void (const Handle_HYDROData_Object&)];
+  %MethodCode
+
+    Handle(HYDROData_Object) aGeomObj =
+      Handle(HYDROData_Object)::DownCast( createHandle( a0 ) );
+    if ( !aGeomObj.IsNull() )
+    {
+      Py_BEGIN_ALLOW_THREADS
+      sipSelfWasArg ? sipCpp->HYDROData_Zone::AddGeometryObject( aGeomObj ) : 
+                      sipCpp->AddGeometryObject( aGeomObj );
+      Py_END_ALLOW_THREADS
+    }
+
+  %End
+
+  /**
+   * Returns all geometry objects of zone.
+   */
+  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 RemovePolyline();
+  void SetInterpolator( HYDROData_IInterpolator* theInter );
 
   /**
-   * Returns the painter path. The painter path is construct by polyline
+   * * Returns the interpolator of zone object.
    */
-  QPainterPath GetPainterPath() const;
+  HYDROData_IInterpolator* GetInterpolator() const;
 
 protected: