Merge branch 'BR_v14_rc' into BR_quadtree

[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h

diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h
index 35d51d10e4b182b084f560bdbdad26c1981b7c9b..a54800f13544cbadbfe469cfdfa3d46cf2c9108a 100644 (file)
--- a/src/HYDROData/HYDROData_CalculationCase.h
+++ b/src/HYDROData/HYDROData_CalculationCase.h
@@ -42,6 +42,8 @@ class Handle(HYDROData_PolylineXY);
 class Handle(HYDROData_ShapesGroup);
 class Handle(HYDROData_SplittedShapesGroup);
 class Handle(HYDROData_Document);
+class Handle(HYDROData_StricklerTable);
+class Handle(HYDROData_LandCover);
 
 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
 
@@ -75,14 +77,18 @@ public:
   enum DataTag
   {
     DataTag_First = HYDROData_Entity::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_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:
@@ -177,6 +183,43 @@ public:
   HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
 
 
+    /**
+   * Sets reference Strickler table for calculation case.
+   */
+  HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
+
+  /**
+   * Returns reference Strickler table of calculation case.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const;
+
+  /**
+   * Remove reference Strickler table from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveStricklerTable();
+
+
+  /**
+   * Add new one reference land cover for calculation case.
+   */
+  HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover );
+
+  /**
+   * Returns all reference land covers of calculation case.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const;
+
+  /**
+   * Removes reference land cover from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveLandCover( const Handle(HYDROData_LandCover)& theLandCover );
+
+  /**
+   * Removes all reference land covers from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveLandCovers();
+
+
   /**
    * Add new one child region for calculation case.
    * The new region is added into the list of reference regions.
@@ -315,16 +358,22 @@ public:
   HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
   HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
 
-  HYDRODATA_EXPORT void ClearRules( const bool theIsSetToUpdate = true );
-  HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Object)&    theObject1,
-                                 HYDROData_PriorityType             thePriority,
-                                 const Handle(HYDROData_Object)&    theObject2,
-                                 HYDROData_Zone::MergeAltitudesType theMergeType );
+  HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag,
+                                    const bool theIsSetToUpdate = true );
+  HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)&     theObject1,
+                                 HYDROData_PriorityType              thePriority,
+                                 const Handle(HYDROData_Entity)&     theObject2,
+                                 HYDROData_Zone::MergeAltitudesType  theMergeType,
+                                 HYDROData_CalculationCase::DataTag  theDataTag );
   HYDRODATA_EXPORT bool GetRule( int theIndex, 
-                                 Handle(HYDROData_Object)&           theObject1,
+                                 Handle(HYDROData_Entity)&           theObject1,
                                  HYDROData_PriorityType&             thePriority,
-                                 Handle(HYDROData_Object)&           theObject2,
-                                 HYDROData_Zone::MergeAltitudesType& theMergeType ) const;
+                                 Handle(HYDROData_Entity)&           theObject2,
+                                 HYDROData_Zone::MergeAltitudesType& theMergeType,
+                                 HYDROData_CalculationCase::DataTag& theDataTag ) const;
+
+  HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode );
+  HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const;
 
   HYDRODATA_EXPORT QString DumpRules() const;
 
@@ -358,21 +407,7 @@ private:
                const TopTools_ListOfShape&                   theFaces,
                const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
                QString& theGeomObjEntry ) const;
-
-  /**
-   * Publish the given shape in GEOM as a GEOM object.
-   * \param theGeomEngine GEOM module engine
-   * \param theStudy SALOMEDS study, used for publishing of the shape
-   * \param theShape the shape to publish as a GEOM object
-   * \param theName the name of the published object
-   * \return the published GEOM object
-   */
-  GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var  theGeomEngine,
-                                            SALOMEDS::Study_ptr theStudy,
-                                            const TopoDS_Shape& theShape, 
-                                            const QString&      theName,
-                                            QString& theGeomObjEntry ) const;
-
+  
   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
   void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,