#refs 522 (very draft) //import only

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

diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h
index e851eaa3685355efc22da818014e510e6ce28303..750fbfe3e679202f600a8fc6b39ef1253f8c9cc7 100644 (file)
--- a/src/HYDROData/HYDROData_CalculationCase.h
+++ b/src/HYDROData/HYDROData_CalculationCase.h
@@ -1,4 +1,24 @@
-
+// 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
@@ -7,6 +27,7 @@
 #include <HYDROData_SplitToZonesTool.h>
 #include <HYDROData_PriorityQueue.h>
 #include <HYDROData_Zone.h>
+#include <HYDROData_Warning.h>
 
 // IDL includes
 #include <SALOMEconfig.h>
@@ -206,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.
@@ -214,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
@@ -291,13 +319,20 @@ public:
   HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
   HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
 
-  HYDRODATA_EXPORT void ClearRules();
+  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 QString DumpRules();
+  HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
 
 private:
 
@@ -325,7 +360,8 @@ private:
   bool Export( GEOM::GEOM_Gen_var                            theGeomEngine,
                SALOMEDS::Study_ptr                           theStudy,
                const TopTools_ListOfShape&                   theFaces,
-               const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs ) const;
+               const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
+               QString& theGeomObjEntry ) const;
 
   /**
    * Publish the given shape in GEOM as a GEOM object.
@@ -338,7 +374,8 @@ 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;
 
   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
                          const HYDROData_SplitToZonesTool::SplitDataList& theZones );
@@ -350,6 +387,8 @@ private:
 
   void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
 
+  void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
+
 protected:
   friend class HYDROData_Iterator;
 
@@ -363,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