Salome HOME
Merge branch 'BR_MULTI_BATHS' into HEAD
[modules/hydro.git] / src / HYDROPy / HYDROData_CalculationCase.sip
index fc09eeb1b535a23e9cb92729c517e58e7fa46fbc..01b1ae04f7d8ef86a4e7cb3120f2f5bd5ea94729 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
@@ -66,6 +62,27 @@ public:
     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_SplitGroups,               ///< reference split groups
+    DataTag_CustomRules,               ///< custom rules
+    DataTag_AssignmentMode,            ///< assignment mode
+    DataTag_StricklerTable,            ///< reference Strickler table
+    DataTag_LandCover_Obsolete,                 ///< reference land covers
+    DataTag_CustomLandCoverRules_Obsolete,      ///< custom rules for land covers priority
+    DataTag_AssignmentLandCoverMode_Obsolete,   ///< assignment mode of land covers priority
+    DataTag_ChildLandCoverRegion_Obsolete,      ///< child land cover regions
+    DataTag_LandCoverRegion_Obsolete            ///< reference land cover regions
+  };
+
 public:      
   /**
    * Add new one reference geometry object for calculation case.
@@ -91,7 +108,8 @@ public:
   /**
    * Removes reference geometry object from calculation case.
    */
-  void RemoveGeometryObject( HYDROData_Object theObject ) [void ( const Handle_HYDROData_Object& )];
+  void RemoveGeometryObject( HYDROData_Object theObject )
+  [void ( const Handle_HYDROData_Object& )];
   %MethodCode
     Handle(HYDROData_Object) aRef =
       Handle(HYDROData_Object)::DownCast( createHandle( a0 ) );
@@ -277,12 +295,12 @@ public:
   /**
    * Returns all reference geometry groups of calculation case.
    */
-  HYDROData_SequenceOfObjects GetSplittedGroups() const;
+  HYDROData_SequenceOfObjects GetSplitGroups() const;
 
   /**
    * Removes all reference geometry groups from calculation case.
    */
-  void RemoveSplittedGroups();
+  void RemoveSplitGroups();
 
 
   /**
@@ -293,10 +311,28 @@ 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
 
+  /**
+   * Returns strickler coefficient for given point.
+   * \param thePoint the point to examine
+   * \return result strickler coefficient
+   */
+  double GetStricklerCoefficientForPoint( const double theCoordX,
+                                          const double theCoordY ) const [double ( const gp_XY& ) ];
+  %MethodCode
+    gp_XY aPnt( a0, a1 );
+  
+    Py_BEGIN_ALLOW_THREADS
+    sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetStricklerCoefficientForPoint( aPnt ) : 
+                             sipCpp->GetStricklerCoefficientForPoint( aPnt );
+    Py_END_ALLOW_THREADS
+  %End
+
   /**
    * Returns altitude for given point.
    * \param thePoint the point to examine
@@ -363,8 +399,9 @@ public:
    */
   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& )];
+                                                      HYDROData_Region                    theRegion,
+                                                      int                                 theMethod = 0) const
+  [NCollection_Sequence<double> ( const NCollection_Sequence<gp_XY>&, const Handle_HYDROData_Region&, int)];
   %MethodCode
 
     NCollection_Sequence<gp_XY> aPnts;
@@ -378,16 +415,39 @@ public:
 
     Handle(HYDROData_Region) aRefRegion =
       Handle(HYDROData_Region)::DownCast( createHandle( a2 ) );
-
+    int aMethod = a3;
+    
     NCollection_Sequence<double> aRes;
     Py_BEGIN_ALLOW_THREADS
-    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefRegion ) : 
-                           sipCpp->GetAltitudesForPoints( aPnts, aRefRegion );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefRegion, aMethod ) : 
+                           sipCpp->GetAltitudesForPoints( aPnts, aRefRegion, aMethod );
     Py_END_ALLOW_THREADS
     
     sipRes = new NCollection_Sequence<double>( aRes );
   %End
 
+  std::vector<double> GetStricklerCoefficientForPoints( const NCollection_Sequence<double>& theCoordsX,
+                                                        const NCollection_Sequence<double>& theCoordsY,
+                                                        double DefValue,
+                                                        bool UseMax ) const
+  [std::vector<double> ( const NCollection_Sequence<gp_XY>&, double, bool)];
+  %MethodCode
+  std::vector<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.push_back( aPnt );
+  }
+  std::vector<double> aRes;
+  Py_BEGIN_ALLOW_THREADS
+  aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetStricklerCoefficientForPoints( aPnts, a2, a3 ) : 
+                         sipCpp->GetStricklerCoefficientForPoints( aPnts, a2, a3 );
+  Py_END_ALLOW_THREADS
+  sipRes = new std::vector<double>( aRes );
+  %End
+
+
   /**
    * Returns altitudes for given points on given zone.
    * \param thePoints the points to examine
@@ -396,8 +456,9 @@ public:
    */
   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& )];
+                                                      HYDROData_Zone                      theZone,
+                                                      int                                 theMethod = 0) const
+  [NCollection_Sequence<double> ( const NCollection_Sequence<gp_XY>&, const Handle_HYDROData_Zone&, int )];
   %MethodCode
 
     NCollection_Sequence<gp_XY> aPnts;
@@ -411,11 +472,12 @@ public:
 
     Handle(HYDROData_Zone) aRefZone =
       Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) );
+    int aMethod = a3;
 
     NCollection_Sequence<double> aRes;
     Py_BEGIN_ALLOW_THREADS
-    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefZone ) : 
-                           sipCpp->GetAltitudesForPoints( aPnts, aRefZone );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefZone, aMethod ) : 
+                           sipCpp->GetAltitudesForPoints( aPnts, aRefZone, aMethod );
     Py_END_ALLOW_THREADS
     
     sipRes = new NCollection_Sequence<double>( aRes );
@@ -486,22 +548,23 @@ public:
   %End
 
 
-  void ClearRules();
+  void ClearRules( HYDROData_CalculationCase::DataTag theDataTag );
 
-  void AddRule( HYDROData_Object                   theObject1,
+  void AddRule( HYDROData_Entity                   theObject1,
                 HYDROData_PriorityType             thePriority,
-                HYDROData_Object                   theObject2,
-                HYDROData_Zone::MergeAltitudesType theMergeType )
-  [void ( const Handle_HYDROData_Object&, HYDROData_PriorityType, const Handle_HYDROData_Object&, HYDROData_Zone::MergeAltitudesType )];
+                HYDROData_Entity                   theObject2,
+                HYDROData_Zone::MergeType          theMergeType,
+                               HYDROData_CalculationCase::DataTag theDataTag )
+  [void ( const Handle_HYDROData_Entity&, HYDROData_PriorityType, const Handle_HYDROData_Entity&, HYDROData_Zone::MergeType, HYDROData_CalculationCase::DataTag )];
   %MethodCode
-    Handle(HYDROData_Object) anObject1 =
-      Handle(HYDROData_Object)::DownCast( createHandle( a0 ) );
-    Handle(HYDROData_Object) anObject2 =
-      Handle(HYDROData_Object)::DownCast( createHandle( a2 ) );
+    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 ) : 
-                    sipCpp->AddRule( anObject1, a1, anObject2, a3 );
+    sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRule( anObject1, a1, anObject2, a3, a4 ) : 
+                    sipCpp->AddRule( anObject1, a1, anObject2, a3, a4 );
     Py_END_ALLOW_THREADS
   %End