idl/HOMARD_YACS.idl

   1 // Copyright (C) 2011-2013  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Remarques :
  20 // L'ordre de description des fonctions est le meme dans tous les fichiers
  21 // HOMARD_aaaa.idl, HOMARD_aaaa.hxx, HOMARD_aaaa.cxx, HOMARD_aaaa_i.hxx, HOMARD_aaaa_i.cxx :
  22 // 1. Les generalites : Name, Delete, DumpPython, Dump, Restore
  23 // 2. Les caracteristiques
  24 // 3. Le lien avec les autres structures
  25 //
  26 // Quand les 2 fonctions Setxxx et Getxxx sont presentes, Setxxx est decrit en premier
  27 //
  28
  29 #ifndef _HOMARD_YACS_IDL
  30 #define _HOMARD_YACS_IDL
  31
  32 #include "SALOME_Component.idl"
  33 #include "SALOME_Exception.idl"
  34 #include "SALOMEDS.idl"
  35
  36 module HOMARD
  37 {
  38   interface HOMARD_YACS : Engines::EngineComponent
  39   {
  40 // Generalites
  41     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  42     string   GetName()                                     raises (SALOME::SALOME_Exception);
  43
  44     long     Delete(in long Option)                        raises (SALOME::SALOME_Exception);
  45
  46     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  47
  48 // Caracteristiques
  49     void     SetType (in long Type)                        raises (SALOME::SALOME_Exception);
  50     long     GetType()                                     raises (SALOME::SALOME_Exception);
  51
  52     void     SetMaxIter (in long MaxIter)                  raises (SALOME::SALOME_Exception);
  53     long     GetMaxIter()                                  raises (SALOME::SALOME_Exception);
  54     void     SetMaxNode (in long MaxNode)                  raises (SALOME::SALOME_Exception);
  55     long     GetMaxNode()                                  raises (SALOME::SALOME_Exception);
  56     void     SetMaxElem (in long MaxElem)                  raises (SALOME::SALOME_Exception);
  57     long     GetMaxElem()                                  raises (SALOME::SALOME_Exception);
  58
  59     void     SetTestConvergence (in long TypeTest, in double VRef)
  60                                                            raises (SALOME::SALOME_Exception);
  61     long     GetTestConvergenceType()                      raises (SALOME::SALOME_Exception);
  62     double   GetTestConvergenceVRef()                      raises (SALOME::SALOME_Exception);
  63
  64     void     SetDirName(in string NomDir)                  raises (SALOME::SALOME_Exception);
  65     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
  66
  67     void     SetMeshFile(in string MeshFile)               raises (SALOME::SALOME_Exception);
  68     string   GetMeshFile()                                 raises (SALOME::SALOME_Exception);
  69
  70     void     SetScriptFile(in string ScriptFile)           raises (SALOME::SALOME_Exception);
  71     string   GetScriptFile()                               raises (SALOME::SALOME_Exception);
  72
  73     void     SetXMLFile(in string XMLFile)                 raises (SALOME::SALOME_Exception);
  74     string   GetXMLFile()                                  raises (SALOME::SALOME_Exception);
  75
  76     long     Write()                                       raises (SALOME::SALOME_Exception);
  77     long     WriteOnFile( in string YACSFile )             raises (SALOME::SALOME_Exception);
  78
  79 // Liens avec les autres structures
  80     void     SetCaseName(in string NomCas)                 raises (SALOME::SALOME_Exception);
  81     string   GetCaseName()                                 raises (SALOME::SALOME_Exception);
  82
  83 // Divers
  84   };
  85 };
  86 #endif