Salome HOME
Merge commit '9dd90968eb8ad86e7e6ae67f48bb6110bd4ffbdc' into BR_LCM_COMP
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index 9d84b3d4f596dba35ba27a92fd6d4b4c4f4048bd..7db0d86bfcb91b9e6b5d7895984ad58968818b18 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;
 
@@ -43,7 +53,7 @@ class Handle(HYDROData_ShapesGroup);
 class Handle(HYDROData_SplittedShapesGroup);
 class Handle(HYDROData_Document);
 class Handle(HYDROData_StricklerTable);
-class Handle(HYDROData_LandCover);
+class Handle(HYDROData_LandCoverMap);
 
 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
 
@@ -86,11 +96,14 @@ 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
+
+    DataTag_LandCoverMap,              ///< reference to land cover map
   };
 
 public:
@@ -111,7 +124,8 @@ public:
   /**
    * 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.
@@ -203,59 +217,36 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveStricklerTable();
 
-
   /**
-   * Add new one reference Land Cover for calculation case.
-   * \param theLandCover the Land Cover to add
-   * \return true in case of success
-   */
-  HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover );
-
-  /**
-   * Returns all reference Land Covers of calculation case.
-   * \return the list of referenced Land Covers
+   * Returns reference Land Cover Map of calculation case.
+   * \return the referenced Land Cover Map
    */
-  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const;
-
-  /**
-   * Removes reference Land Cover from calculation case.
-   * \param theLandCover the Land Cover to remove
-   */
-  HYDRODATA_EXPORT virtual void RemoveLandCover( const Handle(HYDROData_LandCover)& theLandCover );
-
-  /**
-   * Removes all reference Land Covers from calculation case.
-   */
-  HYDRODATA_EXPORT virtual void RemoveLandCovers();
+  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.
-   * \param theLandCover if true - Land Cover region will be added
    * \return the created region
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone,
-                                                                  const bool theLandCover ); 
+  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.
-   * \param theLandCover if true - Land Cover region will bw created
    * \return true in case of success
    */
-  HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion,
-                                           const bool theLandCover );
+  HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
 
   /**
    * Returns all reference regions of calculation case.
-   * \param theLandCover if true - Land Cover regions will be returned
    * \return the list of reference regions
    */
-  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
 
   /**
    * Updates names of regions to correct order.
@@ -265,16 +256,13 @@ public:
   /**
    * Removes reference region from calculation case.
    * \param theRegion the region to remove
-   * \param theLandCover if true - it means that Land Cover region to be removed
    */
-  HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion,
-                                              const bool theLandCover ); 
+  HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion ); 
 
   /**
    * Removes all reference regions from calculation case.
-   * \param theLandCover if true - it means that Land Cover regions to be removed
    */
-  HYDRODATA_EXPORT virtual void RemoveRegions( const bool theLandCover );
+  HYDRODATA_EXPORT virtual void RemoveRegions();
 
   /**
    * Returns all reference geometry groups of calculation case.
@@ -297,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
@@ -331,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
@@ -354,22 +354,18 @@ public:
   /**
    * Returns region to which the point is belongs.
    * \param thePoint the point to examine
-   * \param theLandCover the flag indicating,
    * if it is needed to search Land Cover region
    * \return result region
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint,
-                                                                        const bool theLandCover ) const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint ) const;
 
   /**
    * Returns zone to which the point is belongs.
    * \param thePoint the point to examine
-   * \param theLandCover the flag indicating,
    * if it is needed to search Land Cover zone
    * \return result zone
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint,
-                                                                    const bool theLandCover ) const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
 
   /**
    * Returns classification of point for given zone.
@@ -398,9 +394,6 @@ public:
                                  HYDROData_Zone::MergeType& theMergeType,
                                  HYDROData_CalculationCase::DataTag& theDataTag ) const;
 
-  HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode );
-  HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const;
-
   HYDRODATA_EXPORT QString DumpRules() const;
 
   HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
@@ -413,7 +406,6 @@ private:
    */
   Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
                                          const QString& thePrefixOrName,
-                                         const bool theLandCover,
                                          bool isPrefix = true );
 
   /**
@@ -429,32 +421,18 @@ private:
    * \param theSplittedGroups 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;
-
-  /**
-   * 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;
-
+#endif
+  
   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
-                         const HYDROData_SplitToZonesTool::SplitDataList& theZones,
-                         const bool theLandCover );
+                         const HYDROData_SplitToZonesTool::SplitDataList& theZones );
   void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
-                          const HYDROData_SplitToZonesTool::SplitDataList& theZones,
-                          const bool theLandCover );
+                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
 
   void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
                             const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
@@ -467,8 +445,9 @@ private:
                            const QString& theOldCaseName,
                            const QString& theName );
   
-  void DumpRegionsToPython( QStringList& theResList,
-                            MapOfTreatedObjects& theTreatedObjects,
+  void DumpRegionsToPython( QStringList&                       theResList,
+                            const QString&                     thePyScriptPath,
+                            MapOfTreatedObjects&               theTreatedObjects,
                             const HYDROData_SequenceOfObjects& theRegions ) const;
 
 protected: