idl/HOMARD_Iteration.idl

   1 // Copyright (C) 2011-2012  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
  40   interface HOMARD_Iteration : Engines::EngineComponent
  41   {
  42 // Generalites
  43     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  44     string   GetName()                                     raises (SALOME::SALOME_Exception);
  45
  46     long     Delete()                                      raises (SALOME::SALOME_Exception);
  47
  48     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  49
  50 // Caracteristiques
  51     void     SetDirName(in string NomDir)                  raises (SALOME::SALOME_Exception);
  52     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
  53
  54     void     SetNumber(in long NumIter)                    raises (SALOME::SALOME_Exception);
  55     long     GetNumber()                                   raises (SALOME::SALOME_Exception);
  56
  57     void     SetEtat(in boolean State)                     raises (SALOME::SALOME_Exception);
  58     boolean  GetEtat()                                     raises (SALOME::SALOME_Exception);
  59
  60     void     SetMeshName(in string NomMesh)                raises (SALOME::SALOME_Exception);
  61     string   GetMeshName()                                 raises (SALOME::SALOME_Exception);
  62
  63     void     SetMeshFile(in string MeshFile)               raises (SALOME::SALOME_Exception);
  64     string   GetMeshFile()                                 raises (SALOME::SALOME_Exception);
  65
  66     void     SetFieldFile(in string FieldFile)             raises (SALOME::SALOME_Exception);
  67     string   GetFieldFile()                                raises (SALOME::SALOME_Exception);
  68     void     SetTimeStepRank(in long TimeStep, in long Rank)
  69                                                            raises (SALOME::SALOME_Exception);
  70     void     SetTimeStepRankLast()                         raises (SALOME::SALOME_Exception);
  71     long     GetTimeStep()                                 raises (SALOME::SALOME_Exception);
  72     long     GetRank()                                     raises (SALOME::SALOME_Exception);
  73
  74     void     SetMessFile(in string MessFile)               raises (SALOME::SALOME_Exception);
  75     string   GetMessFile()                                 raises (SALOME::SALOME_Exception);
  76
  77     long     Compute(in long etatMenage)                   raises (SALOME::SALOME_Exception);
  78
  79 // Liens avec les autres iterations
  80     HOMARD_Iteration NextIteration(in string NomIter)      raises (SALOME::SALOME_Exception);
  81
  82     void     LinkNextIteration(in string NomIter)          raises (SALOME::SALOME_Exception);
  83     void     UnLinkNextIteration(in string NomIter)        raises (SALOME::SALOME_Exception);
  84     listeIterFilles GetIterations()                        raises (SALOME::SALOME_Exception);
  85
  86     void     SetIterParentName(in string NomIterParent)    raises (SALOME::SALOME_Exception);
  87     string   GetIterParentName()                           raises (SALOME::SALOME_Exception);
  88     HOMARD_Iteration GetIterParent()                       raises (SALOME::SALOME_Exception);
  89
  90 // Liens avec les autres structures
  91     void     SetCaseName(in string NomCas)                 raises (SALOME::SALOME_Exception);
  92     string   GetCaseName()                                 raises (SALOME::SALOME_Exception);
  93
  94     void     AssociateHypo(in string NomHypo)              raises (SALOME::SALOME_Exception);
  95     void     SetHypoName(in string NomHypo)                raises (SALOME::SALOME_Exception);
  96     string   GetHypoName()                                 raises (SALOME::SALOME_Exception);
  97   };
  98 };
  99 #endif