idl/MED_Gen.idl

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/
  19 //
  20 //=============================================================================
  21 // File      : Med_Gen.idl
  22 // Project   : SALOME
  23 // Copyright : EDF 2001
  24 //=============================================================================
  25
  26 #ifndef _Med_GEN_IDL_
  27 #define _Med_GEN_IDL_
  28
  29
  30 #include "SALOME_Exception.idl"
  31 #include "SALOME_Component.idl"
  32 #include "SALOMEDS.idl"
  33 #include "MED.idl"
  34
  35 module SALOME_MED
  36 {
  37   interface MED_Gen : Engines::Component, SALOMEDS::Driver
  38   {
  39     /*!
  40       it returns a Corba pointer %MESH on the mesh stored in the .med file
  41       <VAR>fileName</VAR> with the name <VAR>meshName</VAR>.
  42      */
  43     SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
  44                                     in string meshName)
  45       raises(SALOME::SALOME_Exception);
  46
  47     /*!
  48       it returns a Corba pointer %FIELD on the field instance with the order
  49       <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
  50       file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>.
  51      */
  52     SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
  53                                       in string fieldName, in long ordre,
  54                                       in long iter)
  55       raises (SALOME::SALOME_Exception);
  56
  57     /*!
  58       it returns a Corba pointer on the %MED object regrouping all objects
  59       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>. All instances
  60       of the fields are stored without their type.
  61     */
  62     SALOME_MED::MED readStructFile(in string fileName,
  63                                    in string studyName)
  64       raises (SALOME::SALOME_Exception);
  65
  66     /*!
  67       It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
  68       <VAR>studyName</VAR>. The %MED object regroups all objects
  69       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
  70       instances of the fields are stored with their own type.
  71     */
  72     void readStructFileWithFieldType(in string fileName,
  73                                      in string studyName)
  74       raises (SALOME::SALOME_Exception);
  75   };
  76
  77 };
  78
  79 #endif