idl/MED_Gen.idl

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