Update comments for ExportMED / ExportToMED methods

[modules/smesh.git] / idl / SMESH_Gen.idl

diff --git a/idl/SMESH_Gen.idl b/idl/SMESH_Gen.idl
index 5617d144baf6e5ab3d610ab88eae4cb8d4447424..32486e5aa718aaef67ec90bfbac72213e45c7252 100644 (file)
--- a/idl/SMESH_Gen.idl
+++ b/idl/SMESH_Gen.idl
@@ -1,11 +1,27 @@
-//=============================================================================
-// File      : SMESH_Gen.idl
-// Created   : jeu avr 11 15:26:35 CEST 2002
-// Author    : Paul RASCLE, EDF
-// Project   : SALOME
-// Copyright : EDF 2002
-// $Header$
-//=============================================================================
+//  Copyright (C) 2003  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. 
+// 
+//  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+//
+//
+//
+//  File   : SMESH_Gen.idl
+//  Author : Paul RASCLE, EDF
+//  $Header$

 
 #ifndef _SMESH_GEN_IDL_
 #define _SMESH_GEN_IDL_
 
 #ifndef _SMESH_GEN_IDL_
 #define _SMESH_GEN_IDL_


@@ -15,27 +31,45 @@
 #include "SALOMEDS.idl"
 
 #include "GEOM_Gen.idl"
 #include "SALOMEDS.idl"
 
 #include "GEOM_Gen.idl"

-#include "GEOM_Shape.idl"

 
 #include "SMESH_Mesh.idl"
 #include "SMESH_Hypothesis.idl"
 
 module SMESH
 {
 
 #include "SMESH_Mesh.idl"
 #include "SMESH_Hypothesis.idl"
 
 module SMESH
 {

-  typedef sequence<GEOM::GEOM_Shape> shape_array;
+  typedef sequence<GEOM::GEOM_Object> object_array;
+  typedef sequence<SMESH_Mesh> mesh_array;
+
+  interface FilterManager;
+  interface SMESH_Pattern;

 
   interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
   {
 
   interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
   {

+
+    FilterManager CreateFilterManager();
+
+    SMESH_Pattern GetPattern();
+
+    /*!
+      Set the current study
+     */
+    void SetCurrentStudy( in SALOMEDS::Study theStudy );
+
+    /*!
+      Get the current study
+     */
+    SALOMEDS::Study GetCurrentStudy();
+

     /*!
     /*!

-     * Create an hypothesis that can be shared by differents parts of the mesh.
+     * Create a hypothesis that can be shared by differents parts of the mesh.

      * An hypothesis is either:
      * - a method used to generate or modify a part of the mesh (algorithm).
      * - a parameter or a law used by an algorithm.
      * Algorithms are 1D, 2D or 3D.
      */
      * An hypothesis is either:
      * - a method used to generate or modify a part of the mesh (algorithm).
      * - a parameter or a law used by an algorithm.
      * Algorithms are 1D, 2D or 3D.
      */

-    SMESH_Hypothesis CreateHypothesis( in string anHyp,
-                                      in long studyId)
-      raises (SALOME::SALOME_Exception);
+    SMESH_Hypothesis CreateHypothesis( in string theHypName,
+                                      in string theLibName )
+      raises ( SALOME::SALOME_Exception );

 
     /*!
      * Create a Mesh object, given a geometry shape.
 
     /*!
      * Create a Mesh object, given a geometry shape.


@@ -44,51 +78,64 @@ module SMESH
      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
      * with TopoDS_Shapes
      */
      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
      * with TopoDS_Shapes
      */

-     SMESH_Mesh Init(in GEOM::GEOM_Gen geomEngine,
-                    in long studyId,
-                    in GEOM::GEOM_Shape aShape)
-       raises (SALOME::SALOME_Exception);
+    SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
+      raises ( SALOME::SALOME_Exception );
+    
+    /*!
+     * Create Mesh object importing data from given UNV file
+     */
+    SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
+      raises ( SALOME::SALOME_Exception );
+
+    /*!
+     * Create Mesh object(s) importing data from given MED file
+     */
+     mesh_array CreateMeshesFromMED( in string theFileName,
+                                    out SMESH::DriverMED_ReadStatus theStatus )
+       raises ( SALOME::SALOME_Exception );
+
+    /*!
+     * Create Mesh object importing data from given STL file
+     */
+    SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
+      raises ( SALOME::SALOME_Exception );

 
     /*!
      * Create a Mesh object, without a geometry shape reference
      */
 
     /*!
      * Create a Mesh object, without a geometry shape reference
      */

-//      SMESH_Mesh NewEmpty(in GEOM::GEOM_Gen geomEngine,
-//                      in long studyId)
-//        raises (SALOME::SALOME_Exception);
+//      SMESH_Mesh NewEmpty()
+//        raises ( SALOME::SALOME_Exception );

 
     /*!
      * Mesh a subShape. 
      * First, verify list of hypothesis associated with the subShape,
      * return NOK if hypothesis are not sufficient
      */
 
     /*!
      * Mesh a subShape. 
      * First, verify list of hypothesis associated with the subShape,
      * return NOK if hypothesis are not sufficient
      */

-    boolean Compute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
-      raises (SALOME::SALOME_Exception);
+    boolean Compute( in SMESH_Mesh       theMesh, 
+                    in GEOM::GEOM_Object theSubObject )
+      raises ( SALOME::SALOME_Exception );

 
     /*!
      * 
      */
 
 
     /*!
      * 
      */
 

-    boolean IsReadyToCompute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
-      raises (SALOME::SALOME_Exception);
+    boolean IsReadyToCompute( in SMESH_Mesh       theMesh, 
+                             in GEOM::GEOM_Object theSubObject )
+      raises ( SALOME::SALOME_Exception );

 
     /*!
      * 
      */
 
     /*!
      * 
      */

-    long_array GetSubShapesId(in GEOM::GEOM_Gen geomEngine,
-                            in long studyId,
-                            in GEOM::GEOM_Shape mainShape,
-                            in shape_array listOfSubShape)
-       raises (SALOME::SALOME_Exception);
+    long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
+                            in object_array theListOfSubObjects )
+       raises ( SALOME::SALOME_Exception );

     
     /*!
      * 
      */
     
     /*!
      * 
      */

-    //    long_array GetSubMeshesState(in GEOM::GEOM_Gen geomEngine,
-    //                          in long studyId,
-    //                          in shape_array listOfSubShape)
-    //  raises (SALOME::SALOME_Exception);
+    //    long_array GetSubMeshesState( in object_array theListOfSubShape )
+    //  raises ( SALOME::SALOME_Exception );

     
     

-

   };
 
 };
   };
 
 };