Salome HOME
SIP: HYDROData_ObstacleAltitude is included.
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index 83d75bbeab969b72f10f63a9f6982b7d3d580b40..f8c3ef554f750dd7e7cd41350242387629326aa3 100644 (file)
@@ -5,12 +5,22 @@
 
 #include <HYDROData_Entity.h>
 
+// IDL includes
+#include <SALOMEconfig.h>
+#include CORBA_SERVER_HEADER(GEOM_Gen)
+
+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);
 
 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
 
@@ -21,6 +31,14 @@ DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
  */
 class HYDROData_CalculationCase : public HYDROData_Entity
 {
+public:
+
+  enum PointClassification
+  {
+    POINT_OUT,  ///< point is out of zone face
+    POINT_IN,   ///< point is inside of zone face
+    POINT_ON    ///< point is on the edge of zone face
+  };
 
 protected:
 
@@ -33,7 +51,9 @@ protected:
     DataTag_GeometryObject,   ///< reference geometry objects
     DataTag_ChildRegion,      ///< child regions
     DataTag_Region,           ///< reference regions
-    DataTag_Polyline          ///< reference boundary polyline
+    DataTag_Polyline,         ///< reference boundary polyline
+    DataTag_GeometryGroup,    ///< reference geometry groups
+    DataTag_SplittedGroups,   ///< reference splitted groups
   };
 
 public:
@@ -47,7 +67,7 @@ public:
 
   /**
    * Updates the name of this object.
-   * Reimplemented to update the names of regions and zones.
+   * Reimplemented to update the names of regions, zones and splitted groups.
    */
   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
 
@@ -56,6 +76,12 @@ public:
    */
   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 
+  /**
+   * Update the calcualtion case object.
+   * Call this method whenever you made changes for object data.
+   */
+  HYDRODATA_EXPORT virtual void Update();
+
   /**
    * Returns the list of all reference objects of this object.
    */
@@ -64,12 +90,6 @@ public:
 public:      
   // Public methods to work with Calculation
 
-  /**
-   * Split reference geometry objects to non-intersected regions.
-   */
-  HYDRODATA_EXPORT virtual void SplitGeometryObjects();
-
-
   /**
    * Add new one reference geometry object for calculation case.
    */
@@ -91,6 +111,27 @@ public:
   HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
 
 
+  /**
+   * Add new one reference geometry group for calculation case.
+   */
+  HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
+
+  /**
+   * Returns all reference geometry groups of calculation case.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
+
+  /**
+   * Removes reference geometry group from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
+
+  /**
+   * Removes all reference geometry groups from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
+
+
   /**
    * Sets reference boundary polyline object for calculation case.
    */
@@ -142,11 +183,53 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveRegions();
 
+  
   /**
-   * Returns shell containing faces which correspond to regions.
-   * \return shell as TopoDS_Shell
+   * Returns all reference geometry groups of calculation case.
    */
-  HYDRODATA_EXPORT virtual TopoDS_Shell GetShell();
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
+
+  /**
+   * Removes all reference geometry groups from calculation case.
+   */
+  HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
+
+
+  /**
+   * 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
+   * \return true in case of success
+   */
+  HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
+                                        SALOMEDS::Study_ptr theStudy );
+
+public:      
+  // Public methods to work with Calculation services
+
+  /**
+   * Returns altitude for given point.
+   * \param thePoint the point to examine
+   * \return result altitude value
+   */
+  HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
+
+  /**
+   * Returns zone to which the point is belongs.
+   * \param thePoint the point to examine
+   * \return result zone
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
+
+  /**
+   * Returns classification of point for given zone.
+   * \param thePoint the point to examine
+   * \param theZone the zone to examine
+   * \return result classification
+   */
+  HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
+    const gp_XY&                  thePoint,
+    const Handle(HYDROData_Zone)& theZone ) const;
 
 private:
 
@@ -156,6 +239,36 @@ private:
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion();
 
+  /**
+   * Add new one splitted edges group for calculation case.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup();
+
+  /**
+   * 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
+   * \return true in case of success
+   */
+  HYDRODATA_EXPORT bool Export( GEOM::GEOM_Gen_var theGeomEngine,
+                                SALOMEDS::Study_ptr theStudy,
+                                const TopTools_ListOfShape& theFaces,
+                                const HYDROData_SequenceOfObjects& theSplittedGroups );
+
+  /**
+   * 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 );
 
 protected: