Salome HOME
Separate action "Find bottom" for context menu.
[modules/hydro.git] / src / HYDROData / HYDROData_CalculationCase.h
index 435a98c19f50d1370778a95e81b2d564eed2503d..750fbfe3e679202f600a8fc6b39ef1253f8c9cc7 100644 (file)
@@ -1,9 +1,33 @@
-
+// Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef HYDROData_CalculationCase_HeaderFile
 #define HYDROData_CalculationCase_HeaderFile
 
 #include <HYDROData_ShapesGroup.h>
+#include <HYDROData_SplitToZonesTool.h>
+#include <HYDROData_PriorityQueue.h>
+#include <HYDROData_Zone.h>
+#include <HYDROData_Warning.h>
 
 // IDL includes
 #include <SALOMEconfig.h>
@@ -21,6 +45,7 @@ class Handle(HYDROData_Zone);
 class Handle(HYDROData_PolylineXY);
 class Handle(HYDROData_ShapesGroup);
 class Handle(HYDROData_SplittedShapesGroup);
+class Handle(HYDROData_Document);
 
 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
 
@@ -40,7 +65,13 @@ public:
     POINT_ON    ///< point is on the edge of zone face
   };
 
-protected:
+  enum AssignmentMode
+  {
+    MANUAL = 0,
+    AUTOMATIC,
+  };
+
+public:
 
   /**
    * Enumeration of tags corresponding to the persistent object parameters.
@@ -54,6 +85,8 @@ protected:
     DataTag_Polyline,         ///< reference boundary polyline
     DataTag_GeometryGroup,    ///< reference geometry groups
     DataTag_SplittedGroups,   ///< reference splitted groups
+    DataTag_CustomRules,      ///< custom rules
+    DataTag_AssignmentMode,   ///< assignment mode
   };
 
 public:
@@ -194,6 +227,12 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
 
+  /**
+   * Exports the calculation case data (shell and groups) to GEOM module.
+   * \param theStudyId the id of the study where the GEOM module should be used for export
+   * \return the entry of the GEOM object (empty string in the case of error)
+   */
+  HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const;
 
   /**
    * Exports the calculation case data (shell and groups) to GEOM module.
@@ -202,7 +241,8 @@ public:
    * \return true in case of success
    */
   HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var  theGeomEngine,
-                                        SALOMEDS::Study_ptr theStudy ) const;
+                                        SALOMEDS::Study_ptr theStudy,
+                                        QString& theGeomObjEntry ) const;
 
 public:      
   // Public methods to work with Calculation services
@@ -214,6 +254,15 @@ public:
    */
   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
 
+  /**
+   * Returns altitude for given point on given region.
+   * \param thePoint the point to examine
+   * \param theRegion reference region to check
+   * \return result altitude value
+   */
+  HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                    thePoint,
+                                                       const Handle(HYDROData_Region)& theRegion ) const;
+
   /**
    * Returns altitude for given point on given zone.
    * \param thePoint the point to examine
@@ -223,6 +272,16 @@ public:
   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                  thePoint,
                                                        const Handle(HYDROData_Zone)& theZone ) const;
 
+  /**
+   * Returns altitudes for given points on given region.
+   * \param thePoints the points to examine
+   * \param theRegion reference region to check
+   * \return result altitude value
+   */
+  HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints( 
+    const NCollection_Sequence<gp_XY>& thePoints,
+    const Handle(HYDROData_Region)&    theRegion ) const;
+
   /**
    * Returns altitudes for given points on given zone.
    * \param thePoints the points to examine
@@ -233,6 +292,13 @@ public:
     const NCollection_Sequence<gp_XY>& thePoints,
     const Handle(HYDROData_Zone)&      theZone ) const;
 
+  /**
+   * Returns region to which the point is belongs.
+   * \param thePoint the point to examine
+   * \return result region
+   */
+  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
@@ -250,18 +316,38 @@ public:
     const gp_XY&                  thePoint,
     const Handle(HYDROData_Zone)& theZone ) const;
 
+  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 bool GetRule( int theIndex, 
+                                 Handle(HYDROData_Object)&           theObject1,
+                                 HYDROData_PriorityType&             thePriority,
+                                 Handle(HYDROData_Object)&           theObject2,
+                                 HYDROData_Zone::MergeAltitudesType& theMergeType ) const;
+
+  HYDRODATA_EXPORT QString DumpRules() const;
+
+  HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
+
 private:
 
   /**
    * Add new one region for calculation case.
    * The new region is added into the list of reference regions.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion();
+  Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
+                                         const QString& thePrefixOrName,
+                                         bool isPrefix = true );
 
   /**
    * Add new one splitted edges group for calculation case.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup();
+  Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName );
 
   /**
    * Exports the given faces as shell and the given groups to GEOM module.
@@ -271,10 +357,11 @@ private:
    * \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;
+  bool Export( GEOM::GEOM_Gen_var                            theGeomEngine,
+               SALOMEDS::Study_ptr                           theStudy,
+               const TopTools_ListOfShape&                   theFaces,
+               const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
+               QString& theGeomObjEntry ) const;
 
   /**
    * Publish the given shape in GEOM as a GEOM object.
@@ -287,10 +374,22 @@ private:
   GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var  theGeomEngine,
                                             SALOMEDS::Study_ptr theStudy,
                                             const TopoDS_Shape& theShape, 
-                                            const QString&      theName ) const;
+                                            const QString&      theName,
+                                            QString& theGeomObjEntry ) const;
 
-protected:
+  void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
+                         const HYDROData_SplitToZonesTool::SplitDataList& theZones );
+  void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
+                          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 SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
 
+protected:
   friend class HYDROData_Iterator;
 
   /**
@@ -303,6 +402,14 @@ protected:
    * Destructs properties of the object and object itself, removes it from the document.
    */
   HYDRODATA_EXPORT ~HYDROData_CalculationCase();
+
+  void DumpSampleMeshing( QStringList& theScript,
+                          const QString& theStudyName,
+                          const QString& theGeomShapeName,
+                          const QString& theMeshName ) const;
+
+private:
+  HYDROData_Warning myLastWarning;
 };
 
 #endif