Salome HOME
first part of the porting on OCCT 7.0
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index c055663c34843d60a9d5319a674ffc6d857925b9..af03f9518a787a415296d1f9b3f8bac641ba69a4 100644 (file)
@@ -43,23 +43,19 @@ class gp_XY;
 
 class TopoDS_Shape;
 class TopoDS_Shell;
-class TopTools_ListOfShape;
-
-class Handle(HYDROData_Object);
-class Handle(HYDROData_Region);
-class Handle(HYDROData_Zone);
-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)
 
+class HYDROData_Object;
+class HYDROData_Region;
+class HYDROData_Zone;
+class HYDROData_PolylineXY;
+class HYDROData_ShapesGroup;
+class HYDROData_SplitShapesGroup;
+class HYDROData_Document;
+class HYDROData_StricklerTable;
+class HYDROData_LandCoverMap;
 
 /**\class HYDROData_CalculationCase
- * \brief Calculation case is defined by selection of Geometry objects with or without \93Zone of water\94.
+ * \brief Calculation case is defined by selection of Geometry objects with or without �Zone of water�.
  *
  */
 class HYDROData_CalculationCase : public HYDROData_Entity
@@ -92,20 +88,22 @@ public:
     DataTag_Region,                    ///< reference regions
     DataTag_Polyline,                  ///< reference boundary polyline
     DataTag_GeometryGroup,             ///< reference geometry groups
-    DataTag_SplittedGroups,            ///< reference splitted groups
+    DataTag_SplitGroups,               ///< reference split 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
-    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:
-
-  DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
+  DEFINE_STANDARD_RTTIEXT(HYDROData_CalculationCase, HYDROData_Entity);
 
   /**
    * Returns the kind of this object. Must be redefined in all objects of known type.
@@ -114,14 +112,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 );  
 
   /**
    * 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.
@@ -213,59 +212,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
+   * Returns reference Land Cover Map of calculation case.
+   * \return the referenced Land Cover Map
    */
-  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
-   */
-  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.
@@ -275,26 +251,23 @@ 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.
    */
-  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.
@@ -335,7 +308,8 @@ public:
    * \return result altitude value
    */
   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                    thePoint,
-                                                       const Handle(HYDROData_Region)& theRegion ) const;
+                                                       const Handle(HYDROData_Region)& theRegion,
+                                                       int theMethod = 0) const;
 
   /**
    * Returns altitude for given point on given zone.
@@ -344,7 +318,8 @@ public:
    * \return result altitude value
    */
   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                  thePoint,
-                                                       const Handle(HYDROData_Zone)& theZone ) const;
+                                                       const Handle(HYDROData_Zone)& theZone,
+                                                       int theMethod = 0) const;
 
   /**
    * Returns strickler coefficient for given point.
@@ -361,7 +336,8 @@ public:
    */
   HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints( 
     const NCollection_Sequence<gp_XY>& thePoints,
-    const Handle(HYDROData_Region)&    theRegion ) const;
+    const Handle(HYDROData_Region)&    theRegion,
+    int theMethod = 0) const;
 
   /**
    * Returns altitudes for given points on given zone.
@@ -371,27 +347,24 @@ public:
    */
   HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints( 
     const NCollection_Sequence<gp_XY>& thePoints,
-    const Handle(HYDROData_Zone)&      theZone ) const;
+    const Handle(HYDROData_Zone)&      theZone,
+    int theMethod = 0) const;
 
   /**
    * 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.
@@ -420,11 +393,7 @@ 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 QString DumpLandCoverRules() const;
 
   HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
 
@@ -436,20 +405,19 @@ private:
    */
   Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
                                          const QString& thePrefixOrName,
-                                         const bool theLandCover,
                                          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
@@ -461,17 +429,14 @@ private:
 #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 );
 
   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 = "" );
 
@@ -479,8 +444,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: