Salome HOME
Merge branch 'BR_v14_rc' of ssh://git.salome-platform.org/modules/hydro into BR_v14_rc
[modules/hydro.git] / src / HYDROPy / HYDROData_CalculationCase.sip
index e50f6850067038ec354179978e574457d15aed83..d925944a17564b6667b7fc32c00ee4115145dd3f 100644 (file)
@@ -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,                 ///< 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
+  };
+
 public:      
   /**
    * Add new one reference geometry object for calculation case.
@@ -205,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 ) [Handle_HYDROData_Region ( const Handle_HYDROData_Zone& )];
+  HYDROData_Region AddNewRegion( HYDROData_Zone theZone, const bool theLandCover ) [Handle_HYDROData_Region ( const Handle_HYDROData_Zone&, const bool )];
   %MethodCode
     Handle(HYDROData_Zone) aRef =
       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
@@ -214,8 +231,8 @@ public:
     if ( !aRef.IsNull() )
     {
       Py_BEGIN_ALLOW_THREADS
-      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddNewRegion( aRef ) : 
-                             sipCpp->AddNewRegion( aRef );
+      aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddNewRegion( aRef, a1 ) : 
+                             sipCpp->AddNewRegion( aRef, a1 );
       Py_END_ALLOW_THREADS
     }
     
@@ -226,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 ) [bool ( const Handle_HYDROData_Region& )];
+  bool AddRegion( HYDROData_Region theRegion, const bool theLandCover ) [bool ( const Handle_HYDROData_Region&, const bool )];
   %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 ):
-                               sipCpp->AddRegion( aRef );
+      sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRegion( aRef, a1 ):
+                               sipCpp->AddRegion( aRef, a1 );
       Py_END_ALLOW_THREADS
     }
   %End
@@ -242,7 +259,7 @@ public:
   /**
    * Returns all reference regions of calculation case.
    */
-  HYDROData_SequenceOfObjects GetRegions() const;
+  HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
 
   /**
    * Updates names of regions to correct order.
@@ -252,7 +269,7 @@ public:
   /**
    * Removes reference region from calculation case.
    */
-  void RemoveRegion( HYDROData_Region theRegion ) [void ( const Handle_HYDROData_Region& )];
+  void RemoveRegion( HYDROData_Region theRegion, const bool theLandCover ) [void ( const Handle_HYDROData_Region&, const bool )];
   %MethodCode
     Handle(HYDROData_Region) aRef =
       Handle(HYDROData_Region)::DownCast( createHandle( a0 ) );
@@ -260,9 +277,9 @@ public:
     {
       Py_BEGIN_ALLOW_THREADS
       if ( sipSelfWasArg ) {
-        sipCpp->HYDROData_CalculationCase::RemoveRegion( aRef );
+        sipCpp->HYDROData_CalculationCase::RemoveRegion( aRef, a1 );
       } else {
-        sipCpp->RemoveRegion( aRef );
+        sipCpp->RemoveRegion( aRef, a1 );
       }
       Py_END_ALLOW_THREADS
     }
@@ -271,7 +288,7 @@ public:
   /**
    * Removes all reference regions from calculation case.
    */
-  void RemoveRegions();
+  void RemoveRegions( const bool theLandCover );
 
   
   /**
@@ -429,16 +446,17 @@ public:
    * \return result region
    */
   HYDROData_Region GetRegionFromPoint( const double theCoordX,
-                                       const double theCoordY ) const
-  [Handle_HYDROData_Region ( const gp_XY& )];
+                                       const double theCoordY,
+                                                                          const bool theLandCover ) const
+  [Handle_HYDROData_Region ( const gp_XY&, const bool )];
   %MethodCode
     Handle(HYDROData_Region) aRes;
     
     gp_XY aPnt( a0, a1 );
   
     Py_BEGIN_ALLOW_THREADS
-    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetRegionFromPoint( aPnt ) : 
-                           sipCpp->GetRegionFromPoint( aPnt );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetRegionFromPoint( aPnt, a2 ) : 
+                           sipCpp->GetRegionFromPoint( aPnt, a2 );
     Py_END_ALLOW_THREADS
     
     sipRes = (HYDROData_Region*)createPointer( aRes );
@@ -450,16 +468,17 @@ public:
    * \return result zone
    */
   HYDROData_Zone GetZoneFromPoint( const double theCoordX,
-                                   const double theCoordY ) const
-  [Handle_HYDROData_Zone ( const gp_XY& )];
+                                   const double theCoordY,
+                                                                  const bool theLandCover ) const
+  [Handle_HYDROData_Zone ( const gp_XY&, const bool )];
   %MethodCode
     Handle(HYDROData_Zone) aRes;
     
     gp_XY aPnt( a0, a1 );
   
     Py_BEGIN_ALLOW_THREADS
-    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt ) : 
-                           sipCpp->GetZoneFromPoint( aPnt );
+    aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetZoneFromPoint( aPnt, a2 ) : 
+                           sipCpp->GetZoneFromPoint( aPnt, a2 );
     Py_END_ALLOW_THREADS
     
     sipRes = (HYDROData_Zone*)createPointer( aRes );
@@ -488,30 +507,35 @@ 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
 
   QString DumpRules();
+  QString DumpLandCoverRules();
 
   void SetAssignmentMode( AssignmentMode theMode );
   AssignmentMode GetAssignmentMode() const;
 
+  void SetAssignmentLandCoverMode( AssignmentMode theMode );
+  AssignmentMode GetAssignmentLandCoverMode() const;
+
 protected:
 
   /**