Salome HOME
#662: new presentation for the land cover map
[modules/hydro.git] / src / HYDROPy / HYDROData_CalculationCase.sip
index d925944a17564b6667b7fc32c00ee4115145dd3f..c1ebd5ce2309b61fae11cf41d8abc5c8c826f75d 100644 (file)
@@ -76,11 +76,11 @@ public:
     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
-       DataTag_ChildLandCoverRegion,      ///< child land cover regions
-    DataTag_LandCoverRegion            ///< reference land cover regions
+    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:      
@@ -222,7 +222,7 @@ public:
    * The label of theZone is changed during this operation
    * because of new region becomes the new parent for this zone.
    */
-  HYDROData_Region AddNewRegion( HYDROData_Zone theZone, const bool theLandCover ) [Handle_HYDROData_Region ( const Handle_HYDROData_Zone&, const bool )];
+  HYDROData_Region AddNewRegion( HYDROData_Zone theZone ) [Handle_HYDROData_Region ( const Handle_HYDROData_Zone& )];
   %MethodCode
     Handle(HYDROData_Zone) aRef =
       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
@@ -231,8 +231,8 @@ public:
     if ( !aRef.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddNewRegion( aRef, a1 ) : 
-                             sipCpp->AddNewRegion( aRef, a1 );
+      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddNewRegion( aRef ) : 
+                             sipCpp->AddNewRegion( aRef );
       Py_END_ALLOW_THREADS
     }
     
@@ -243,15 +243,15 @@ public:
    * Add new one reference region for calculation case.
    * The label of theRegion is changed in case if old parent is not this calculation.
    */
-  bool AddRegion( HYDROData_Region theRegion, const bool theLandCover ) [bool ( const Handle_HYDROData_Region&, const bool )];
+  bool AddRegion( HYDROData_Region theRegion ) [bool ( const Handle_HYDROData_Region& )];
   %MethodCode
     Handle(HYDROData_Region) aRef =
       Handle(HYDROData_Region)::DownCast( createHandle( a0 ) );
     if ( !aRef.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRegion( aRef, a1 ):
-                               sipCpp->AddRegion( aRef, a1 );
+      sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRegion( aRef ):
+                               sipCpp->AddRegion( aRef );
       Py_END_ALLOW_THREADS
     }
   %End
@@ -259,7 +259,7 @@ public:
   /**
    * Returns all reference regions of calculation case.
    */
-  HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
+  HYDROData_SequenceOfObjects GetRegions() const;
 
   /**
    * Updates names of regions to correct order.
@@ -269,7 +269,7 @@ public:
   /**
    * Removes reference region from calculation case.
    */
-  void RemoveRegion( HYDROData_Region theRegion, const bool theLandCover ) [void ( const Handle_HYDROData_Region&, const bool )];
+  void RemoveRegion( HYDROData_Region theRegion ) [void ( const Handle_HYDROData_Region& )];
   %MethodCode
     Handle(HYDROData_Region) aRef =
       Handle(HYDROData_Region)::DownCast( createHandle( a0 ) );
@@ -277,9 +277,9 @@ public:
     {
       Py_BEGIN_ALLOW_THREADS
       if ( sipSelfWasArg ) {
-        sipCpp->HYDROData_CalculationCase::RemoveRegion( aRef, a1 );
+        sipCpp->HYDROData_CalculationCase::RemoveRegion( aRef );
       } else {
-        sipCpp->RemoveRegion( aRef, a1 );
+        sipCpp->RemoveRegion( aRef );
       }
       Py_END_ALLOW_THREADS
     }
@@ -288,7 +288,7 @@ public:
   /**
    * Removes all reference regions from calculation case.
    */
-  void RemoveRegions( const bool theLandCover );
+  void RemoveRegions();
 
   
   /**
@@ -316,6 +316,22 @@ public:
 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
@@ -446,17 +462,16 @@ public:
    * \return result region
    */
   HYDROData_Region GetRegionFromPoint( const double theCoordX,
-                                       const double theCoordY,
-                                                                          const bool theLandCover ) const
-  [Handle_HYDROData_Region ( const gp_XY&, const bool )];
+                                       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, a2 ) : 
-                           sipCpp->GetRegionFromPoint( aPnt, a2 );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetRegionFromPoint( aPnt ) : 
+                           sipCpp->GetRegionFromPoint( aPnt );
     Py_END_ALLOW_THREADS
     
     sipRes = (HYDROData_Region*)createPointer( aRes );
@@ -468,17 +483,16 @@ public:
    * \return result zone
    */
   HYDROData_Zone GetZoneFromPoint( const double theCoordX,
-                                   const double theCoordY,
-                                                                  const bool theLandCover ) const
-  [Handle_HYDROData_Zone ( const gp_XY&, const bool )];
+                                   const double theCoordY ) const
+  [Handle_HYDROData_Zone ( const gp_XY& )];
   %MethodCode
     Handle(HYDROData_Zone) aRes;
     
     gp_XY aPnt( a0, a1 );
   
     Py_BEGIN_ALLOW_THREADS
-    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt, a2 ) : 
-                           sipCpp->GetZoneFromPoint( aPnt, a2 );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt ) : 
+                           sipCpp->GetZoneFromPoint( aPnt );
     Py_END_ALLOW_THREADS
     
     sipRes = (HYDROData_Zone*)createPointer( aRes );
@@ -528,14 +542,10 @@ public:
   %End
 
   QString DumpRules();
-  QString DumpLandCoverRules();
 
   void SetAssignmentMode( AssignmentMode theMode );
   AssignmentMode GetAssignmentMode() const;
 
-  void SetAssignmentLandCoverMode( AssignmentMode theMode );
-  AssignmentMode GetAssignmentLandCoverMode() const;
-
 protected:
 
   /**