idl/MED_Gen.idl

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