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