#662: new presentation for the land cover map

[modules/hydro.git] / src / HYDROPy / HYDROData_CalculationCase.sip

diff --git a/src/HYDROPy/HYDROData_CalculationCase.sip b/src/HYDROPy/HYDROData_CalculationCase.sip
index e50f6850067038ec354179978e574457d15aed83..c1ebd5ce2309b61fae11cf41d8abc5c8c826f75d 100644 (file)
--- a/src/HYDROPy/HYDROData_CalculationCase.sip
+++ b/src/HYDROPy/HYDROData_CalculationCase.sip
@@ -1,8 +1,4 @@
-// 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
-//
+// 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
@@ -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_SplittedGroups,            ///< reference splitted 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.
@@ -299,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
@@ -488,22 +521,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