Salome HOME
Création automatique de schémas YACS à partir d'un cas
[modules/homard.git] / 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
38 module HOMARD
39 {
40  typedef sequence<double> extrema ;
41  typedef sequence<string> ListGroupType ;
42  typedef sequence<string> ListBoundaryGroupType ;
43
44
45  interface HOMARD_Cas : Engines::EngineComponent
46   {
47 // Generalites
48     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
49     string   GetName()                                     raises (SALOME::SALOME_Exception);
50
51     long     Delete(in long Option)                        raises (SALOME::SALOME_Exception);
52
53     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
54
55 // Caracteristiques
56     void     SetDirName(in string NomDir)                  raises (SALOME::SALOME_Exception);
57     string   GetDirName()                                  raises (SALOME::SALOME_Exception);
58
59     long     GetState()                                    raises (SALOME::SALOME_Exception);
60
61     long     GetNumberofIter()                             raises (SALOME::SALOME_Exception);
62
63     void     SetConfType(in long ConfType)                 raises (SALOME::SALOME_Exception);
64     long     GetConfType()                                 raises (SALOME::SALOME_Exception);
65
66     void     SetBoundingBox(in extrema LesExtremes)        raises (SALOME::SALOME_Exception);
67     extrema  GetBoundingBox()                              raises (SALOME::SALOME_Exception);
68
69     void     AddGroup(in string Group)                     raises (SALOME::SALOME_Exception);
70     void     SetGroups(in ListGroupType ListGroup)         raises (SALOME::SALOME_Exception);
71     ListGroupType GetGroups()                              raises (SALOME::SALOME_Exception);
72
73     void     AddBoundaryGroup(in string BoundaryName, in string Group)
74                                                            raises (SALOME::SALOME_Exception);
75     ListBoundaryGroupType GetBoundaryGroup()               raises (SALOME::SALOME_Exception);
76
77     void     SetPyram(in long Pyram)                       raises (SALOME::SALOME_Exception);
78     long     GetPyram()                                    raises (SALOME::SALOME_Exception);
79
80     void     MeshInfo(in long Qual, in long Diam, in long Conn, in long Tail, in long Inte)
81                                                            raises (SALOME::SALOME_Exception);
82
83 // Liens avec les autres structures
84     string   GetIter0Name ()                               raises (SALOME::SALOME_Exception);
85     HOMARD_Iteration GetIter0 ()                           raises (SALOME::SALOME_Exception);
86
87     HOMARD_Iteration NextIteration(in string IterName)     raises (SALOME::SALOME_Exception);
88
89     HOMARD_Iteration LastIteration()                       raises (SALOME::SALOME_Exception);
90
91     void     AddIteration (in string IterName)             raises (SALOME::SALOME_Exception);
92
93 // YACS
94     long     WriteYACSSchema(in string ScriptFile, in string DirName, in string MeshFile)
95                                                            raises (SALOME::SALOME_Exception);
96
97
98   };
99 };
100 #endif