Salome HOME
Merge branch 'BR_v14_rc' into BR_SINUSX_FORMAT
[modules/hydro.git] / src / HYDROPy / HYDROData_CalculationCase.sip
index c3f78b0c3116ec95afbb0551a86aa07aaaf0e0c0..7a2eeeafb60b8e821d1e2396c1c7ae10c532a19f 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
 
 %ExportedHeaderCode
 #include <HYDROData_CalculationCase.h>
+#include <HYDROData_PriorityQueue.h>
 %End
 
+enum HYDROData_PriorityType
+{
+  LESS,
+  GREATER,
+};
+
 class HYDROData_CalculationCase : public HYDROData_Entity
 {
 
@@ -53,6 +56,31 @@ public:
     POINT_ON    ///< point is on the edge of zone face
   };
 
+  enum AssignmentMode
+  {
+    MANUAL = 0,
+    AUTOMATIC,
+  };
+
+public:
+
+  enum DataTag
+  {
+    DataTag_First = 100,               ///< first tag, to reserve
+    DataTag_GeometryObject,            ///< reference geometry objects
+    DataTag_ChildRegion,               ///< child regions
+    DataTag_Region,                    ///< reference regions
+    DataTag_Polyline,                  ///< reference boundary polyline
+    DataTag_GeometryGroup,             ///< reference geometry groups
+    DataTag_SplittedGroups,            ///< reference splitted groups
+    DataTag_CustomRules,               ///< custom rules
+    DataTag_AssignmentMode,            ///< assignment mode
+    DataTag_StricklerTable,            ///< reference Strickler table
+    DataTag_LandCover,                 ///< reference land covers
+    DataTag_CustomLandCoverRules,      ///< custom rules for land covers priority
+    DataTag_AssignmentLandCoverMode    ///< assignment mode of land covers priority
+  };
+
 public:      
   /**
    * Add new one reference geometry object for calculation case.
@@ -280,6 +308,8 @@ public:
    */
 //TODO:  virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
 //                       SALOMEDS::Study_ptr theStudy );
+       
+       QString Export( int theStudyId ) const;
 
 public:      
   // Public methods to work with Calculation services
@@ -289,50 +319,144 @@ public:
    * \param thePoint the point to examine
    * \return result altitude value
    */
-  double GetAltitudeForPoint( SIP_PYTUPLE thePoint ) const [double ( const gp_XY& )];
+  double GetAltitudeForPoint( const double theCoordX,
+                              const double theCoordY ) const [double ( const gp_XY& )];
   %MethodCode
-    double aRes = 0.0;
-    
-    double x = 0.0, y = 0.0;
-    if ( PyArg_ParseTuple( a0, "dd", &x, &y ) )
-    {
-      gp_XY aPnt( x, y );
+    gp_XY aPnt( a0, a1 );
   
-      Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt ) : 
+    Py_BEGIN_ALLOW_THREADS
+    sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt ) : 
                              sipCpp->GetAltitudeForPoint( aPnt );
-      Py_END_ALLOW_THREADS
-    }
-    
-    sipRes = aRes;
+    Py_END_ALLOW_THREADS
   %End
 
   /**
-   * Returns altitude for given point.
+   * Returns altitude for given point on given region.
+   * \param thePoint the point to examine
+   * \param theRegion reference region to check
+   * \return result altitude value
+   */
+  double GetAltitudeForPoint( const double     theCoordX,
+                              const double     theCoordY,
+                              HYDROData_Region theRegion ) const
+  [double ( const gp_XY&, const Handle_HYDROData_Region& )];
+  %MethodCode
+    gp_XY aPnt( a0, a1 );
+    Handle(HYDROData_Region) aRefRegion =
+      Handle(HYDROData_Region)::DownCast( createHandle( a2 ) );
+
+    Py_BEGIN_ALLOW_THREADS
+    sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRefRegion ) : 
+                             sipCpp->GetAltitudeForPoint( aPnt, aRefRegion );
+    Py_END_ALLOW_THREADS
+  %End
+
+  /**
+   * Returns altitude for given point on given zone.
    * \param thePoint the point to examine
+   * \param theZone reference zone to check
    * \return result altitude value
    */
-  double GetAltitudeForPoint( SIP_PYTUPLE    thePoint,
+  double GetAltitudeForPoint( const double theCoordX,
+                              const double theCoordY,
                               HYDROData_Zone theZone ) const
-  [double ( const Handle_HYDROData_Zone&, const gp_XY& )];
+  [double ( const gp_XY&, const Handle_HYDROData_Zone& )];
   %MethodCode
-    double aRes = 0.0;
-    
-    double x = 0.0, y = 0.0;
-    if ( PyArg_ParseTuple( a0, "dd", &x, &y ) )
+    gp_XY aPnt( a0, a1 );
+    Handle(HYDROData_Zone) aRefZone =
+      Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) );
+
+    Py_BEGIN_ALLOW_THREADS
+    sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRefZone ) : 
+                             sipCpp->GetAltitudeForPoint( aPnt, aRefZone );
+    Py_END_ALLOW_THREADS
+  %End
+
+  /**
+   * Returns altitudes for given points on given region.
+   * \param thePoints the points to examine
+   * \param theZone reference region to check
+   * \return result altitude value
+   */
+  NCollection_Sequence<double> GetAltitudesForPoints( const NCollection_Sequence<double>& theCoordsX,
+                                                      const NCollection_Sequence<double>& theCoordsY,
+                                                      HYDROData_Region                    theRegion ) const
+  [NCollection_Sequence<double> ( const NCollection_Sequence<gp_XY>&, const Handle_HYDROData_Region& )];
+  %MethodCode
+
+    NCollection_Sequence<gp_XY> aPnts;
+
+    int aLen = qMin( a0->Length(), a1->Length() );
+    for ( int i = 1; i <= aLen; ++i )
     {
-      gp_XY aPnt( x, y );
-  
-      Handle(HYDROData_Zone) aRef =
-        Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
+      gp_XY aPnt( a0->Value( i ), a1->Value( i ) );
+      aPnts.Append( aPnt );
+    }
 
-      Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRef ) : 
-                             sipCpp->GetAltitudeForPoint( aPnt, aRef );
-      Py_END_ALLOW_THREADS
+    Handle(HYDROData_Region) aRefRegion =
+      Handle(HYDROData_Region)::DownCast( createHandle( a2 ) );
+
+    NCollection_Sequence<double> aRes;
+    Py_BEGIN_ALLOW_THREADS
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefRegion ) : 
+                           sipCpp->GetAltitudesForPoints( aPnts, aRefRegion );
+    Py_END_ALLOW_THREADS
+    
+    sipRes = new NCollection_Sequence<double>( aRes );
+  %End
+
+  /**
+   * Returns altitudes for given points on given zone.
+   * \param thePoints the points to examine
+   * \param theZone reference zone to check
+   * \return result altitude value
+   */
+  NCollection_Sequence<double> GetAltitudesForPoints( const NCollection_Sequence<double>& theCoordsX,
+                                                      const NCollection_Sequence<double>& theCoordsY,
+                                                      HYDROData_Zone                      theZone ) const
+  [NCollection_Sequence<double> ( const NCollection_Sequence<gp_XY>&, const Handle_HYDROData_Zone& )];
+  %MethodCode
+
+    NCollection_Sequence<gp_XY> aPnts;
+
+    int aLen = qMin( a0->Length(), a1->Length() );
+    for ( int i = 1; i <= aLen; ++i )
+    {
+      gp_XY aPnt( a0->Value( i ), a1->Value( i ) );
+      aPnts.Append( aPnt );
     }
+
+    Handle(HYDROData_Zone) aRefZone =
+      Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) );
+
+    NCollection_Sequence<double> aRes;
+    Py_BEGIN_ALLOW_THREADS
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefZone ) : 
+                           sipCpp->GetAltitudesForPoints( aPnts, aRefZone );
+    Py_END_ALLOW_THREADS
     
-    sipRes = aRes;
+    sipRes = new NCollection_Sequence<double>( aRes );
+  %End
+  
+  /**
+   * Returns region to which the point is belongs.
+   * \param thePoint the point to examine
+   * \return result region
+   */
+  HYDROData_Region GetRegionFromPoint( const double theCoordX,
+                                       const double theCoordY ) const
+  [Handle_HYDROData_Region ( const gp_XY& )];
+  %MethodCode
+    Handle(HYDROData_Region) aRes;
+    
+    gp_XY aPnt( a0, a1 );
+  
+    Py_BEGIN_ALLOW_THREADS
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetRegionFromPoint( aPnt ) : 
+                           sipCpp->GetRegionFromPoint( aPnt );
+    Py_END_ALLOW_THREADS
+    
+    sipRes = (HYDROData_Region*)createPointer( aRes );
   %End
 
   /**
@@ -340,20 +464,18 @@ public:
    * \param thePoint the point to examine
    * \return result zone
    */
-  HYDROData_Zone GetZoneFromPoint( SIP_PYTUPLE thePoint ) const [Handle_HYDROData_Zone ( const gp_XY& )];
+  HYDROData_Zone GetZoneFromPoint( const double theCoordX,
+                                   const double theCoordY ) const
+  [Handle_HYDROData_Zone ( const gp_XY& )];
   %MethodCode
     Handle(HYDROData_Zone) aRes;
     
-    double x = 0.0, y = 0.0;
-    if ( PyArg_ParseTuple( a0, "dd", &x, &y ) )
-    {
-      gp_XY aPnt( x, y );
+    gp_XY aPnt( a0, a1 );
   
-      Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt ) : 
-                             sipCpp->GetZoneFromPoint( aPnt );
-      Py_END_ALLOW_THREADS
-    }
+    Py_BEGIN_ALLOW_THREADS
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt ) : 
+                           sipCpp->GetZoneFromPoint( aPnt );
+    Py_END_ALLOW_THREADS
     
     sipRes = (HYDROData_Zone*)createPointer( aRes );
   %End
@@ -364,29 +486,48 @@ public:
    * \param theZone the zone to examine
    * \return result classification
    */
-  PointClassification GetPointClassification( SIP_PYTUPLE    thePoint,
+  PointClassification GetPointClassification( const double theCoordX,
+                                              const double theCoordY,
                                               HYDROData_Zone theZone ) const 
   [PointClassification ( const gp_XY&, const Handle_HYDROData_Zone& )];    
   %MethodCode
-    HYDROData_CalculationCase::PointClassification aRes = HYDROData_CalculationCase::POINT_OUT;
-    
-    double x = 0.0, y = 0.0;
-    if ( PyArg_ParseTuple( a0, "dd", &x, &y ) )
-    {
-      gp_XY aPnt( x, y );
+    gp_XY aPnt( a0, a1 );
 
-      Handle(HYDROData_Zone) aRef =
-        Handle(HYDROData_Zone)::DownCast( createHandle( a1 ) );
+    Handle(HYDROData_Zone) aRef =
+      Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) );
 
-      Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetPointClassification( aPnt, aRef ) : 
+    Py_BEGIN_ALLOW_THREADS
+    sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetPointClassification( aPnt, aRef ) : 
                              sipCpp->GetPointClassification( aPnt, aRef );
-      Py_END_ALLOW_THREADS
-    }
-    
-    sipRes = aRes;
+    Py_END_ALLOW_THREADS
+  %End
+
+
+  void ClearRules( HYDROData_CalculationCase::DataTag theDataTag );
+
+  void AddRule( HYDROData_Entity                   theObject1,
+                HYDROData_PriorityType             thePriority,
+                HYDROData_Entity                   theObject2,
+                HYDROData_Zone::MergeAltitudesType theMergeType,
+                               HYDROData_CalculationCase::DataTag theDataTag )
+  [void ( const Handle_HYDROData_Entity&, HYDROData_PriorityType, const Handle_HYDROData_Entity&, HYDROData_Zone::MergeAltitudesType, HYDROData_CalculationCase::DataTag )];
+  %MethodCode
+    Handle(HYDROData_Entity) anObject1 =
+      Handle(HYDROData_Entity)::DownCast( createHandle( a0 ) );
+    Handle(HYDROData_Entity) anObject2 =
+      Handle(HYDROData_Entity)::DownCast( createHandle( a2 ) );
+
+    Py_BEGIN_ALLOW_THREADS
+    sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRule( anObject1, a1, anObject2, a3, a4 ) : 
+                    sipCpp->AddRule( anObject1, a1, anObject2, a3, a4 );
+    Py_END_ALLOW_THREADS
   %End
 
+  QString DumpRules();
+
+  void SetAssignmentMode( AssignmentMode theMode );
+  AssignmentMode GetAssignmentMode() const;
+
 protected:
 
   /**