Access methods for object groups added.

[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h

diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h
index b4a8261db2045b8b8c7c88b89fb14af15dfd4f30..0f2d6579c4c63824ca34f654a9796e441b3e71fd 100644 (file)
--- a/src/HYDROData/HYDROData_CalculationCase.h
+++ b/src/HYDROData/HYDROData_CalculationCase.h
@@ -3,16 +3,24 @@
 #ifndef HYDROData_CalculationCase_HeaderFile
 #define HYDROData_CalculationCase_HeaderFile
 
-#include <HYDROData_Entity.h>
+#include <HYDROData_ShapesGroup.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)
 
@@ -27,9 +35,9 @@ public:
 
   enum PointClassification
   {
-    POINT_OUT,
-    POINT_IN,
-    POINT_ON
+    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:
@@ -43,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:
@@ -57,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 );
 
@@ -101,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.
    */
@@ -152,12 +183,26 @@ 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 ) const;
 
 public:      
   // Public methods to work with Calculation services
@@ -194,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_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs ) 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 ) const;
 
 protected: