Updating a little bit the documentation of the module; especially the

[modules/med.git] / idl / MED_Gen.idl

diff --git a/idl/MED_Gen.idl b/idl/MED_Gen.idl
index 86a68ba5a931aabd063e2dfe3b274ade4f994050..c84f5a241cdfd34649f3829fbf4609a873c9608a 100644 (file)
--- a/idl/MED_Gen.idl
+++ b/idl/MED_Gen.idl
@@ -17,23 +17,45 @@ module SALOME_MED
 {
   interface MED_Gen : Engines::Component, SALOMEDS::Driver
   {
-       SALOME_MED::MESH readMeshInFile(in string fileName,
-                                       in string studyName,
-                                       in string meshName )
-                                       raises (SALOME::SALOME_Exception);
-       SALOME_MED::FIELD readFieldInFile(in string fileName,
-                                       in string studyName,
-                                       in string fieldName,
-                                       in long ordre,
-                                       in long iter )
-                                       raises (SALOME::SALOME_Exception);
-       SALOME_MED::MED readStructFile(in string fileName,
-                                       in string studyName )
-                                       raises (SALOME::SALOME_Exception);
-
-        void readStructFileWithFieldType(in string fileName,
-                                        in string studyName )
-         raises (SALOME::SALOME_Exception);
+    /*!
+      it returns a Corba pointer %MESH on the mesh stored in the .med file
+      <VAR>fileName</VAR> with the name <VAR>meshName</VAR>; and it pushes it
+      in the study named <VAR>studyName</VAR>.
+     */
+    SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
+                                   in string meshName)
+      raises(SALOME::SALOME_Exception);
+
+    /*!
+      it returns a Corba pointer %FIELD on the field instance with the order
+      <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
+      file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>; and it
+      pushes it in the study named <VAR>studyName</VAR>.
+     */
+    SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
+                                     in string fieldName, in long ordre,
+                                     in long iter)
+      raises (SALOME::SALOME_Exception);
+
+    /*!
+      it returns a Corba pointer on the %MED object regrouping all objects
+      (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>; and it pushes
+      all those objects in the study named <VAR>studyName</VAR>. All instances
+      of the fields are stored without their type.
+    */
+    SALOME_MED::MED readStructFile(in string fileName,
+                                  in string studyName)
+      raises (SALOME::SALOME_Exception);
+
+    /*!
+      It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
+      <VAR>studyName</VAR>. The %MED object regroups all objects
+      (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
+      instances of the fields are stored with their own type.
+    */
+    void readStructFileWithFieldType(in string fileName,
+                                    in string studyName)
+      raises (SALOME::SALOME_Exception);
   };
 
 };