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>.
  23      */
  24     SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
  25                                     in string meshName)
  26       raises(SALOME::SALOME_Exception);
  27
  28     /*!
  29       it returns a Corba pointer %FIELD on the field instance with the order
  30       <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
  31       file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>.
  32      */
  33     SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
  34                                       in string fieldName, in long ordre,
  35                                       in long iter)
  36       raises (SALOME::SALOME_Exception);
  37
  38     /*!
  39       it returns a Corba pointer on the %MED object regrouping all objects
  40       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>. All instances
  41       of the fields are stored without their type.
  42     */
  43     SALOME_MED::MED readStructFile(in string fileName,
  44                                    in string studyName)
  45       raises (SALOME::SALOME_Exception);
  46
  47     /*!
  48       It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
  49       <VAR>studyName</VAR>. The %MED object regroups all objects
  50       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
  51       instances of the fields are stored with their own type.
  52     */
  53     void readStructFileWithFieldType(in string fileName,
  54                                      in string studyName)
  55       raises (SALOME::SALOME_Exception);
  56   };
  57
  58 };
  59
  60 #endif