idl/HOMARD_Iteration.idl

   1 // Copyright (C) 2011-2020  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, or (at your option) any later version.
   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
  20 // Remarques :
  21 // L'ordre de description des fonctions est le meme dans tous les fichiers
  22 // HOMARD_aaaa.idl, HOMARD_aaaa.hxx, HOMARD_aaaa.cxx, HOMARD_aaaa_i.hxx, HOMARD_aaaa_i.cxx :
  23 // 1. Les generalites : Name, Delete, DumpPython, Dump, Restore
  24 // 2. Les caracteristiques
  25 // 3. Le lien avec les autres structures
  26 //
  27 // Quand les 2 fonctions Setxxx et Getxxx sont presentes, Setxxx est decrit en premier
  28 //
  29
  30 #ifndef _HOMARD_ITERATION_IDL
  31 #define _HOMARD_ITERATION_IDL
  32
  33 #include "SALOME_Component.idl"
  34 #include "SALOME_Exception.idl"
  35 #include "SALOMEDS.idl"
  36
  37 module ADAPT
  38 {
  39   typedef sequence<string> listeIterFilles ;
  40   typedef sequence<string> listeFieldInterpsIter ;
  41   typedef sequence<string> listeFieldInterpTSRsIter ;
  42
  43   interface HOMARD_Iteration : Engines::EngineComponent
  44   {
  45 // Generalites
  46     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  47     string   GetName()                                     raises (SALOME::SALOME_Exception);
  48
  49     long     Delete(in long Option)                        raises (SALOME::SALOME_Exception);
  50
  51     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  52
  53 // Caracteristiques
  54     void     SetDirNameLoc(in string NomDir)               raises (SALOME::SALOME_Exception);
  55     string   GetDirNameLoc()                               raises (SALOME::SALOME_Exception);
  56
  57     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
  58
  59     void     SetNumber(in long NumIter)                    raises (SALOME::SALOME_Exception);
  60     long     GetNumber()                                   raises (SALOME::SALOME_Exception);
  61
  62     void     SetState(in long State)                       raises (SALOME::SALOME_Exception);
  63     long     GetState()                                    raises (SALOME::SALOME_Exception);
  64
  65     void     SetMeshName(in string NomMesh)                raises (SALOME::SALOME_Exception);
  66     string   GetMeshName()                                 raises (SALOME::SALOME_Exception);
  67
  68     void     SetMeshFile(in string MeshFile)               raises (SALOME::SALOME_Exception);
  69     string   GetMeshFile()                                 raises (SALOME::SALOME_Exception);
  70
  71     void     SetFieldFile(in string FieldFile)             raises (SALOME::SALOME_Exception);
  72     string   GetFieldFile()                                raises (SALOME::SALOME_Exception);
  73
  74 // Instants pour le champ de pilotage
  75     void     SetTimeStep(in long TimeStep)                 raises (SALOME::SALOME_Exception);
  76     void     SetTimeStepRank(in long TimeStep, in long Rank)
  77                                                            raises (SALOME::SALOME_Exception);
  78     void     SetTimeStepRankLast()                         raises (SALOME::SALOME_Exception);
  79     long     GetTimeStep()                                 raises (SALOME::SALOME_Exception);
  80     long     GetRank()                                     raises (SALOME::SALOME_Exception);
  81
  82 // Instants pour un champ a interpoler
  83     void     SetFieldInterpTimeStep(in string FieldInterp, in long TimeStep)
  84                                                            raises (SALOME::SALOME_Exception);
  85     void     SetFieldInterpTimeStepRank(in string FieldInterp, in long TimeStep, in long Rank)
  86                                                            raises (SALOME::SALOME_Exception);
  87     listeFieldInterpTSRsIter GetFieldInterpsTimeStepRank() raises (SALOME::SALOME_Exception);
  88     void     SetFieldInterp(in string FieldInterp)         raises (SALOME::SALOME_Exception);
  89     listeFieldInterpsIter GetFieldInterps()                raises (SALOME::SALOME_Exception);
  90     void     SupprFieldInterps()                           raises (SALOME::SALOME_Exception);
  91
  92 // Fichier des messages
  93     void     SetLogFile(in string LogFile)                 raises (SALOME::SALOME_Exception);
  94     string   GetLogFile()                                  raises (SALOME::SALOME_Exception);
  95
  96     long     Compute(in long etatMenage, in long Option)   raises (SALOME::SALOME_Exception);
  97
  98     void     MeshInfo(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte)
  99                                                            raises (SALOME::SALOME_Exception);
 100     void     MeshInfoOption(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte, in long Option)
 101                                                            raises (SALOME::SALOME_Exception);
 102
 103     void     SetFileInfo(in string FileInfo)               raises (SALOME::SALOME_Exception);
 104     string   GetFileInfo()                                 raises (SALOME::SALOME_Exception);
 105
 106 // Liens avec les autres iterations
 107     HOMARD_Iteration NextIteration(in string NomIter)      raises (SALOME::SALOME_Exception);
 108
 109     void     LinkNextIteration(in string NomIter)          raises (SALOME::SALOME_Exception);
 110     void     UnLinkNextIteration(in string NomIter)        raises (SALOME::SALOME_Exception);
 111     listeIterFilles GetIterations()                        raises (SALOME::SALOME_Exception);
 112
 113     void     SetIterParentName(in string NomIterParent)    raises (SALOME::SALOME_Exception);
 114     string   GetIterParentName()                           raises (SALOME::SALOME_Exception);
 115     HOMARD_Iteration GetIterParent()                       raises (SALOME::SALOME_Exception);
 116
 117 // Liens avec les autres structures
 118     void     SetCaseName(in string NomCas)                 raises (SALOME::SALOME_Exception);
 119     string   GetCaseName()                                 raises (SALOME::SALOME_Exception);
 120
 121     void     AssociateHypo(in string NomHypo)              raises (SALOME::SALOME_Exception);
 122     void     SetHypoName(in string NomHypo)                raises (SALOME::SALOME_Exception);
 123     string   GetHypoName()                                 raises (SALOME::SALOME_Exception);
 124
 125 // Divers
 126     void     SetInfoCompute(in long MessInfo)              raises (SALOME::SALOME_Exception);
 127     long     GetInfoCompute()                              raises (SALOME::SALOME_Exception);
 128   };
 129 };
 130 #endif