idl/HOMARD_Iteration.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_ITERATION_IDL
  30 #define _HOMARD_ITERATION_IDL
  31
  32 #include "SALOME_Component.idl"
  33 #include "SALOME_Exception.idl"
  34 #include "SALOMEDS.idl"
  35
  36 module HOMARD
  37 {
  38   typedef sequence<string> listeIterFilles ;
  39   typedef sequence<string> listeFieldInterpsIter ;
  40   typedef sequence<string> listeFieldInterpTSRsIter ;
  41
  42   interface HOMARD_Iteration : Engines::EngineComponent
  43   {
  44 // Generalites
  45     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  46     string   GetName()                                     raises (SALOME::SALOME_Exception);
  47
  48     long     Delete(in long Option)                        raises (SALOME::SALOME_Exception);
  49
  50     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  51
  52 // Caracteristiques
  53     void     SetDirNameLoc(in string NomDir)               raises (SALOME::SALOME_Exception);
  54     string   GetDirNameLoc()                               raises (SALOME::SALOME_Exception);
  55
  56     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
  57
  58     void     SetNumber(in long NumIter)                    raises (SALOME::SALOME_Exception);
  59     long     GetNumber()                                   raises (SALOME::SALOME_Exception);
  60
  61     void     SetState(in long State)                       raises (SALOME::SALOME_Exception);
  62     long     GetState()                                    raises (SALOME::SALOME_Exception);
  63
  64     void     SetMeshName(in string NomMesh)                raises (SALOME::SALOME_Exception);
  65     string   GetMeshName()                                 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     SetFieldFile(in string FieldFile)             raises (SALOME::SALOME_Exception);
  71     string   GetFieldFile()                                raises (SALOME::SALOME_Exception);
  72
  73 // Instants pour le champ de pilotage
  74     void     SetTimeStep(in long TimeStep)                 raises (SALOME::SALOME_Exception);
  75     void     SetTimeStepRank(in long TimeStep, in long Rank)
  76                                                            raises (SALOME::SALOME_Exception);
  77     void     SetTimeStepRankLast()                         raises (SALOME::SALOME_Exception);
  78     long     GetTimeStep()                                 raises (SALOME::SALOME_Exception);
  79     long     GetRank()                                     raises (SALOME::SALOME_Exception);
  80
  81 // Instants pour un champ a interpoler
  82     void     SetFieldInterpTimeStep(in string FieldInterp, in long TimeStep)
  83                                                            raises (SALOME::SALOME_Exception);
  84     void     SetFieldInterpTimeStepRank(in string FieldInterp, in long TimeStep, in long Rank)
  85                                                            raises (SALOME::SALOME_Exception);
  86     listeFieldInterpTSRsIter GetFieldInterpsTimeStepRank() raises (SALOME::SALOME_Exception);
  87     void     SetFieldInterp(in string FieldInterp)         raises (SALOME::SALOME_Exception);
  88     listeFieldInterpsIter GetFieldInterps()                raises (SALOME::SALOME_Exception);
  89     void     SupprFieldInterps()                           raises (SALOME::SALOME_Exception);
  90
  91 // Fichier des messages
  92     void     SetLogFile(in string LogFile)                 raises (SALOME::SALOME_Exception);
  93     string   GetLogFile()                                  raises (SALOME::SALOME_Exception);
  94
  95     long     Compute(in long etatMenage, in long Option)   raises (SALOME::SALOME_Exception);
  96
  97     void     MeshInfo(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte)
  98                                                            raises (SALOME::SALOME_Exception);
  99     void     MeshInfoOption(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte, in long Option)
 100                                                            raises (SALOME::SALOME_Exception);
 101
 102     void     SetFileInfo(in string FileInfo)               raises (SALOME::SALOME_Exception);
 103     string   GetFileInfo()                                 raises (SALOME::SALOME_Exception);
 104
 105 // Liens avec les autres iterations
 106     HOMARD_Iteration NextIteration(in string NomIter)      raises (SALOME::SALOME_Exception);
 107
 108     void     LinkNextIteration(in string NomIter)          raises (SALOME::SALOME_Exception);
 109     void     UnLinkNextIteration(in string NomIter)        raises (SALOME::SALOME_Exception);
 110     listeIterFilles GetIterations()                        raises (SALOME::SALOME_Exception);
 111
 112     void     SetIterParentName(in string NomIterParent)    raises (SALOME::SALOME_Exception);
 113     string   GetIterParentName()                           raises (SALOME::SALOME_Exception);
 114     HOMARD_Iteration GetIterParent()                       raises (SALOME::SALOME_Exception);
 115
 116 // Liens avec les autres structures
 117     void     SetCaseName(in string NomCas)                 raises (SALOME::SALOME_Exception);
 118     string   GetCaseName()                                 raises (SALOME::SALOME_Exception);
 119
 120     void     AssociateHypo(in string NomHypo)              raises (SALOME::SALOME_Exception);
 121     void     SetHypoName(in string NomHypo)                raises (SALOME::SALOME_Exception);
 122     string   GetHypoName()                                 raises (SALOME::SALOME_Exception);
 123
 124 // Divers
 125     void     SetInfoCompute(in long MessInfo)              raises (SALOME::SALOME_Exception);
 126     long     GetInfoCompute()                              raises (SALOME::SALOME_Exception);
 127   };
 128 };
 129 #endif