Salome HOME
refs #768: local CS change for land covers
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index b03806b1622733937d967f8cd829285838095cc9..88f2c901abb59b7245b4ecd5f824ed30c6ef8308 100644 (file)
 #include <HYDROData_Zone.h>
 #include <HYDROData_Warning.h>
 
+#ifdef WIN32
+  #pragma warning ( disable: 4251 )
+#endif
+
+#ifndef LIGHT_MODE
 // IDL includes
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(GEOM_Gen)
+#endif
+
+#ifdef WIN32
+  #pragma warning( default: 4251 )
+#endif
 
 class gp_XY;
 
@@ -40,8 +50,10 @@ class Handle(HYDROData_Region);
 class Handle(HYDROData_Zone);
 class Handle(HYDROData_PolylineXY);
 class Handle(HYDROData_ShapesGroup);
-class Handle(HYDROData_SplittedShapesGroup);
+class Handle(HYDROData_SplitShapesGroup);
 class Handle(HYDROData_Document);
+class Handle(HYDROData_StricklerTable);
+class Handle(HYDROData_LandCoverMap);
 
 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
 
@@ -75,14 +87,23 @@ 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_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
+
+    DataTag_LandCoverMap,              ///< reference to land cover map
   };
 
 public:
@@ -96,14 +117,15 @@ public:
 
   /**
    * Updates the name of this object.
-   * Reimplemented to update the names of regions, zones and splitted groups.
+   * Reimplemented to update the names of regions, zones and split groups.
    */
-  HYDRODATA_EXPORT virtual void SetName( const QString& theName );
+  HYDRODATA_EXPORT virtual void SetName( const QString& theName );  
 
   /**
    * Dump Calculation object to Python script representation.
    */
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
+                                                     MapOfTreatedObjects& theTreatedObjects ) const;
 
   /**
    * Update the calcualtion case object.
@@ -131,6 +153,7 @@ public:
 
   /**
    * Removes reference geometry object from calculation case.
+   * \param theObject the object to remove
    */
   HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
 
@@ -142,6 +165,7 @@ public:
 
   /**
    * Add new one reference geometry group for calculation case.
+   * \param theGroup the group to add
    */
   HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
 
@@ -152,6 +176,7 @@ public:
 
   /**
    * Removes reference geometry group from calculation case.
+   * \param theGroup the group to remove
    */
   HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
 
@@ -177,23 +202,49 @@ 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();
+
+  /**
+   * Returns reference Land Cover Map of calculation case.
+   * \return the referenced Land Cover Map
+   */
+  HYDRODATA_EXPORT Handle(HYDROData_LandCoverMap) GetLandCoverMap() const;
+
+  HYDRODATA_EXPORT void SetLandCoverMap( const Handle(HYDROData_LandCoverMap)& );
+
   /**
    * Add new one child region for calculation case.
    * The new region is added into the list of reference regions.
    * The label of theZone is changed during this operation
    * because of new region becomes the new parent for this zone.
+   * \return the created region
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone );
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone ); 
 
 
   /**
    * Add new one reference region for calculation case.
    * The label of theRegion is changed in case if old parent is not this calculation.
+   * \return true in case of success
    */
   HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
 
   /**
    * Returns all reference regions of calculation case.
+   * \return the list of reference regions
    */
   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
 
@@ -204,24 +255,24 @@ public:
 
   /**
    * Removes reference region from calculation case.
+   * \param theRegion the region to remove
    */
-  HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
+  HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion ); 
 
   /**
    * Removes all reference regions from calculation case.
    */
   HYDRODATA_EXPORT virtual void RemoveRegions();
 
-  
   /**
    * Returns all reference geometry groups of calculation case.
    */
-  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplitGroups() const;
 
   /**
    * Removes all reference geometry groups from calculation case.
    */
-  HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
+  HYDRODATA_EXPORT virtual void RemoveSplitGroups();
 
   /**
    * Exports the calculation case data (shell and groups) to GEOM module.
@@ -234,11 +285,16 @@ public:
    * Exports the calculation case data (shell and groups) to GEOM module.
    * \param theGeomEngine GEOM module engine
    * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
+   * \param theGeomObjEntry the published GEOM object entry
+   * \param theErrorMsg the error message
    * \return true in case of success
    */
+#ifndef LIGHT_MODE
   HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var  theGeomEngine,
                                         SALOMEDS::Study_ptr theStudy,
-                                        QString& theGeomObjEntry ) const;
+                                        QString& theGeomObjEntry,
+                                        QString& theErrorMsg ) const;
+#endif
 
 public:      
   // Public methods to work with Calculation services
@@ -268,6 +324,13 @@ public:
   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                  thePoint,
                                                        const Handle(HYDROData_Zone)& theZone ) const;
 
+  /**
+   * Returns strickler coefficient for given point.
+   * \param thePoint the point to examine
+   * \return result strickler coefficient
+   */
+  HYDRODATA_EXPORT double GetStricklerCoefficientForPoint( const gp_XY& thePoint ) const;
+
   /**
    * Returns altitudes for given points on given region.
    * \param thePoints the points to examine
@@ -291,6 +354,7 @@ public:
   /**
    * Returns region to which the point is belongs.
    * \param thePoint the point to examine
+   * if it is needed to search Land Cover region
    * \return result region
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint ) const;
@@ -298,6 +362,7 @@ public:
   /**
    * Returns zone to which the point is belongs.
    * \param thePoint the point to examine
+   * if it is needed to search Land Cover zone
    * \return result zone
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
@@ -315,16 +380,19 @@ 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::MergeType 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::MergeType& theMergeType,
+                                 HYDROData_CalculationCase::DataTag& theDataTag ) const;
 
   HYDRODATA_EXPORT QString DumpRules() const;
 
@@ -341,23 +409,25 @@ private:
                                          bool isPrefix = true );
 
   /**
-   * Add new one splitted edges group for calculation case.
+   * Add new one split edges group for calculation case.
    */
-  Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName );
+  Handle(HYDROData_SplitShapesGroup) addNewSplitGroup( const QString& theName );
 
   /**
    * Exports the given faces as shell and the given groups to GEOM module.
    * \param theGeomEngine GEOM module engine
    * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
    * \param theFaces the list of faces to make shell 
-   * \param theSplittedGroups the list of groups
+   * \param theSplitGroups the list of groups
    * \return true in case of success
    */
+#ifndef LIGHT_MODE
   bool Export( GEOM::GEOM_Gen_var                            theGeomEngine,
                SALOMEDS::Study_ptr                           theStudy,
                const TopTools_ListOfShape&                   theFaces,
                const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
                QString& theGeomObjEntry ) const;
+#endif
   
   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
@@ -371,6 +441,15 @@ private:
 
   void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
 
+  void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions,
+                           const QString& theOldCaseName,
+                           const QString& theName );
+  
+  void DumpRegionsToPython( QStringList&                       theResList,
+                            const QString&                     thePyScriptPath,
+                            MapOfTreatedObjects&               theTreatedObjects,
+                            const HYDROData_SequenceOfObjects& theRegions ) const;
+
 protected:
   friend class HYDROData_Iterator;