Salome HOME
Merge branch 'BR_v14_rc' of ssh://git.salome-platform.org/modules/hydro into BR_v14_rc
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index d1a24b4db550ece6f64ae2f5069b7735e274642c..0dd025ed46cd18f2937a8c9b0ec96977a039eaff 100644 (file)
@@ -88,7 +88,9 @@ public:
     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_AssignmentLandCoverMode,   ///< assignment mode of land covers priority
+    DataTag_ChildLandCoverRegion,      ///< child land cover regions
+    DataTag_LandCoverRegion            ///< reference land cover regions
   };
 
 public:
@@ -104,7 +106,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 +139,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 +151,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 +162,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 +188,7 @@ public:
   HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
 
 
-    /**
+  /**
    * Sets reference Strickler table for calculation case.
    */
   HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
@@ -200,22 +205,26 @@ public:
 
 
   /**
-   * Add new one reference land cover for calculation case.
+   * 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.
+   * Returns all reference Land Covers of calculation case.
+   * \return the list of referenced Land Covers
    */
   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const;
 
   /**
-   * Removes reference land cover from calculation case.
+   * 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.
+   * Removes all reference Land Covers from calculation case.
    */
   HYDRODATA_EXPORT virtual void RemoveLandCovers();
 
@@ -225,20 +234,28 @@ public:
    * 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 );
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone,
+                                                                  const bool theLandCover ); 
 
 
   /**
    * 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 );
+  HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion,
+                                           const bool theLandCover );
 
   /**
    * 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;
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
 
   /**
    * Updates names of regions to correct order.
@@ -247,15 +264,18 @@ 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 );
+  HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion,
+                                              const bool theLandCover ); 
 
   /**
    * 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();
+  HYDRODATA_EXPORT virtual void RemoveRegions( const bool theLandCover );
 
-  
   /**
    * Returns all reference geometry groups of calculation case.
    */
@@ -334,16 +354,22 @@ 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;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint,
+                                                                        const bool theLandCover ) 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;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint,
+                                                                    const bool theLandCover ) const;
 
   /**
    * Returns classification of point for given zone.
@@ -358,32 +384,25 @@ 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 void SetAssignmentLandCoverMode( AssignmentMode theMode );
   HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const;
 
-  HYDRODATA_EXPORT void ClearLandCoverRules( const bool theIsSetToUpdate = true );
-  HYDRODATA_EXPORT void AddLandCoverRule( const Handle(HYDROData_LandCover)& theLandCover1,
-                                          HYDROData_PriorityType             thePriority,
-                                          const Handle(HYDROData_LandCover)& theLandCover2/*,
-                                          HYDROData_LandCover::MergeStricklerCoefficientType theMergeType*/ );
-  HYDRODATA_EXPORT bool GetLandCoverRule( int theIndex, 
-                                          Handle(HYDROData_LandCover)&        theLandCover1,
-                                          HYDROData_PriorityType&             thePriority,
-                                          Handle(HYDROData_LandCover)&        theLandCover2/*,
-                                          HYDROData_LandCover::MergeStricklerCoefficientType& theMergeType*/ ) const;
-
   HYDRODATA_EXPORT QString DumpRules() const;
+  HYDRODATA_EXPORT QString DumpLandCoverRules() const;
 
   HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
 
@@ -395,6 +414,7 @@ private:
    */
   Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
                                          const QString& thePrefixOrName,
+                                         const bool theLandCover,
                                          bool isPrefix = true );
 
   /**
@@ -415,33 +435,30 @@ 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 );
+                         const HYDROData_SplitToZonesTool::SplitDataList& theZones,
+                         const bool theLandCover );
   void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
-                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
+                          const HYDROData_SplitToZonesTool::SplitDataList& theZones,
+                          const bool theLandCover );
 
   void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
                             const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
 
   void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
+  void DumpLandCoverRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
 
   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;