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/ or email : webmaster.salome@opencascade.com
  19 //
  20 //=============================================================================
  21 // File      : Med_Gen.idl
  22 // Project   : SALOME
  23 //=============================================================================
  24
  25 #ifndef _Med_GEN_IDL_
  26 #define _Med_GEN_IDL_
  27
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SALOME_Component.idl"
  31 #include "SALOMEDS.idl"
  32 #include "MED.idl"
  33
  34 module SALOME_MED
  35 {
  36   interface MED_Gen_Driver : SALOMEDS::Driver
  37   {
  38   };
  39
  40   interface MED_Gen : Engines::Component, MED_Gen_Driver
  41   {
  42     /*!
  43       it returns a Corba pointer %MESH on the mesh stored in the .med file
  44       <VAR>fileName</VAR> with the name <VAR>meshName</VAR>.
  45      */
  46     SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
  47                                     in string meshName)
  48       raises(SALOME::SALOME_Exception);
  49
  50     /*!
  51       it returns a Corba pointer %FIELD on the field instance with the order
  52       <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
  53       file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>.
  54      */
  55     SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
  56                                       in string fieldName, in long ordre,
  57                                       in long iter)
  58       raises (SALOME::SALOME_Exception);
  59
  60     /*!
  61       it returns a Corba pointer on the %MED object regrouping all objects
  62       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>. All instances
  63       of the fields are stored without their type.
  64     */
  65     SALOME_MED::MED readStructFile(in string fileName,
  66                                    in string studyName)
  67       raises (SALOME::SALOME_Exception);
  68
  69     /*!
  70       It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
  71       <VAR>studyName</VAR>. The %MED object regroups all objects
  72       (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
  73       instances of the fields are stored with their own type.
  74     */
  75     void readStructFileWithFieldType(in string fileName,
  76                                      in string studyName)
  77       raises (SALOME::SALOME_Exception);
  78   };
  79 };
  80
  81 #endif