idl/HOMARD_Cas.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_CAS_IDL
  30 #define _HOMARD_CAS_IDL
  31
  32 #include "SALOME_Component.idl"
  33 #include "SALOME_Exception.idl"
  34 #include "SALOMEDS.idl"
  35
  36 #include "HOMARD_Iteration.idl"
  37 #include "HOMARD_YACS.idl"
  38
  39 module HOMARD
  40 {
  41  typedef sequence<double> extrema ;
  42  typedef sequence<string> ListGroupType ;
  43  typedef sequence<string> ListBoundaryGroupType ;
  44
  45
  46  interface HOMARD_Cas : Engines::EngineComponent
  47   {
  48 // Generalites
  49     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  50     string   GetName()                                     raises (SALOME::SALOME_Exception);
  51
  52     long     Delete(in long Option)                        raises (SALOME::SALOME_Exception);
  53
  54     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  55
  56 // Caracteristiques
  57     void     SetDirName(in string NomDir)                  raises (SALOME::SALOME_Exception);
  58     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
  59
  60     long     GetState()                                    raises (SALOME::SALOME_Exception);
  61
  62     long     GetNumberofIter()                             raises (SALOME::SALOME_Exception);
  63
  64     void     SetConfType(in long ConfType)                 raises (SALOME::SALOME_Exception);
  65     long     GetConfType()                                 raises (SALOME::SALOME_Exception);
  66
  67     void     SetBoundingBox(in extrema LesExtremes)        raises (SALOME::SALOME_Exception);
  68     extrema  GetBoundingBox()                              raises (SALOME::SALOME_Exception);
  69
  70     void     AddGroup(in string Group)                     raises (SALOME::SALOME_Exception);
  71     void     SetGroups(in ListGroupType ListGroup)         raises (SALOME::SALOME_Exception);
  72     ListGroupType GetGroups()                              raises (SALOME::SALOME_Exception);
  73
  74     void     AddBoundaryGroup(in string BoundaryName, in string Group)
  75                                                            raises (SALOME::SALOME_Exception);
  76     ListBoundaryGroupType GetBoundaryGroup()               raises (SALOME::SALOME_Exception);
  77     void     SupprBoundaryGroup()                          raises (SALOME::SALOME_Exception);
  78
  79     void     SetPyram(in long Pyram)                       raises (SALOME::SALOME_Exception);
  80     long     GetPyram()                                    raises (SALOME::SALOME_Exception);
  81
  82     void     MeshInfo(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte)
  83                                                            raises (SALOME::SALOME_Exception);
  84
  85 // Liens avec les autres structures
  86     string   GetIter0Name ()                               raises (SALOME::SALOME_Exception);
  87     HOMARD_Iteration GetIter0 ()                           raises (SALOME::SALOME_Exception);
  88
  89     HOMARD_Iteration NextIteration(in string IterName)     raises (SALOME::SALOME_Exception);
  90
  91     HOMARD_Iteration LastIteration()                       raises (SALOME::SALOME_Exception);
  92
  93     void     AddIteration (in string IterName)             raises (SALOME::SALOME_Exception);
  94
  95 // YACS
  96     HOMARD_YACS CreateYACSSchema(in string YACSName, in string ScriptFile, in string DirName, in string MeshFile)
  97                                                            raises (SALOME::SALOME_Exception);
  98
  99
 100   };
 101 };
 102 #endif