idl/MED_Gen.idl

   1 //=============================================================================
   2 // File      : Med_Gen.idl
   3 // Project   : SALOME
   4 // Copyright : EDF 2001
   5 //=============================================================================
   6
   7 #ifndef _Med_GEN_IDL_
   8 #define _Med_GEN_IDL_
   9
  10
  11 #include "SALOME_Exception.idl"
  12 #include "SALOME_Component.idl"
  13 #include "SALOMEDS.idl"
  14 #include "MED.idl"
  15
  16 module SALOME_MED
  17 {
  18   interface MED_Gen : Engines::Component, SALOMEDS::Driver
  19   {
  20     /*!
  21       it returns a Corba pointer %MESH on the mesh stored in the .med file
  22       <VAR>fileName</VAR> with the name <VAR>meshName</VAR>; and it pushes it
  23       in the study named <VAR>studyName</VAR>.
  24      */
  25     SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
  26                                     in string meshName)
  27       raises(SALOME::SALOME_Exception);
  28
  29     /*!
  30       it returns a Corba pointer %FIELD on the field instance with the order
  31       <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
  32       file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>; and it
  33       pushes it in the study named <VAR>studyName</VAR>.
  34      */
  35     SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
  36                                       in string fieldName, in long ordre,
  37                                       in long iter)
  38       raises (SALOME::SALOME_Exception);
  39
  40     /*!
  41       it returns a Corba pointer on the %MED object regrouping all objects
  42       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>; and it pushes
  43       all those objects in the study named <VAR>studyName</VAR>. All instances
  44       of the fields are stored without their type.
  45     */
  46     SALOME_MED::MED readStructFile(in string fileName,
  47                                    in string studyName)
  48       raises (SALOME::SALOME_Exception);
  49
  50     /*!
  51       It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
  52       <VAR>studyName</VAR>. The %MED object regroups all objects
  53       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
  54       instances of the fields are stored with their own type.
  55     */
  56     void readStructFileWithFieldType(in string fileName,
  57                                      in string studyName)
  58       raises (SALOME::SALOME_Exception);
  59   };
  60
  61 };
  62
  63 #endif