Salome HOME
copyrights are updated
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index a54800f13544cbadbfe469cfdfa3d46cf2c9108a..1a4eb3115bb565fa6739cdd2ccb5d625e4c50455 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,9 +96,13 @@ 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_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:
@@ -104,7 +118,7 @@ public:
    * Updates the name of this object.
    * Reimplemented to update the names of regions, zones and splitted groups.
    */
-  HYDRODATA_EXPORT virtual void SetName( const QString& theName );
+  HYDRODATA_EXPORT virtual void SetName( const QString& theName );  
 
   /**
    * Dump Calculation object to Python script representation.
@@ -137,6 +151,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 );
 
@@ -148,6 +163,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 );
 
@@ -158,6 +174,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 );
 
@@ -183,7 +200,7 @@ public:
   HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
 
 
-    /**
+  /**
    * Sets reference Strickler table for calculation case.
    */
   HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
@@ -198,45 +215,32 @@ public:
    */
   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.
+   * Returns reference Land Cover Map of calculation case.
+   * \return the referenced Land Cover Map
    */
-  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 virtual Handle(HYDROData_LandCoverMap) GetLandCoverMap() const;
 
   /**
    * 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;
 
@@ -247,15 +251,15 @@ 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.
    */
@@ -277,11 +281,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
@@ -311,6 +320,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
@@ -334,6 +350,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;
@@ -341,6 +358,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;
@@ -363,18 +381,15 @@ public:
   HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)&     theObject1,
                                  HYDROData_PriorityType              thePriority,
                                  const Handle(HYDROData_Entity)&     theObject2,
-                                 HYDROData_Zone::MergeAltitudesType  theMergeType,
+                                 HYDROData_Zone::MergeType theMergeType,
                                  HYDROData_CalculationCase::DataTag  theDataTag );
   HYDRODATA_EXPORT bool GetRule( int theIndex, 
                                  Handle(HYDROData_Entity)&           theObject1,
                                  HYDROData_PriorityType&             thePriority,
                                  Handle(HYDROData_Entity)&           theObject2,
-                                 HYDROData_Zone::MergeAltitudesType& theMergeType,
+                                 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;
@@ -402,11 +417,13 @@ 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;
+#endif
   
   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
@@ -420,6 +437,14 @@ 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,
+                            MapOfTreatedObjects& theTreatedObjects,
+                            const HYDROData_SequenceOfObjects& theRegions ) const;
+
 protected:
   friend class HYDROData_Iterator;