idl/HOMARD_Gen.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
  20 #ifndef __HOMARD_GEN__
  21 #define __HOMARD_GEN__
  22
  23 #include "SALOME_Component.idl"
  24 #include "SALOME_Exception.idl"
  25 #include "SALOMEDS.idl"
  26
  27 #include "HOMARD_Cas.idl"
  28 #include "HOMARD_Hypothesis.idl"
  29 #include "HOMARD_Iteration.idl"
  30 #include "HOMARD_Zone.idl"
  31 #include "HOMARD_Boundary.idl"
  32
  33 module HOMARD
  34 {
  35   typedef sequence<string> listeHypotheses;
  36   typedef sequence<string> listeZones;
  37   typedef sequence<string> listeIterations;
  38   typedef sequence<string> listeCases;
  39   typedef sequence<string> listeBoundarys;
  40
  41   interface HOMARD_Gen : Engines::EngineComponent, SALOMEDS::Driver
  42   {
  43 //
  44 // A. Les methodes qui suivent sont celles que l'on retrouvera dans
  45 //    le fichier resources/HOMARDCatalog.xml.in pour definir le composant HOMARD dans YACS
  46 //    A priori, ce sont les seules sont l'utilisateur doit connaitre l'existence.
  47 //
  48 // A.1. Les creations
  49 //
  50     HOMARD_Boundary   CreateBoundaryDi (in string BoundaryName, in string MeshName, in string FileName)
  51                                                            raises (SALOME::SALOME_Exception);
  52     HOMARD_Boundary   CreateBoundaryCylinder (in string BoundaryName,
  53                                       in double Xcentre, in double Ycentre, in double Zcentre,
  54                                       in double Xaxis, in double Yaxis, in double Zaxis,
  55                                       in double Radius)
  56                                                            raises (SALOME::SALOME_Exception);
  57     HOMARD_Boundary   CreateBoundarySphere (in string BoundaryName,
  58                                       in double Xcentre, in double Ycentre, in double Zcentre,
  59                                       in double Radius)
  60                                                            raises (SALOME::SALOME_Exception);
  61     HOMARD_Boundary   CreateBoundaryConeR (in string BoundaryName,
  62                                       in double Xcentre1, in double Ycentre1, in double Zcentre1, in double Radius1,
  63                                       in double Xcentre2, in double Ycentre2, in double Zcentre2, in double Radius2)
  64                                                            raises (SALOME::SALOME_Exception);
  65     HOMARD_Boundary   CreateBoundaryConeA (in string BoundaryName,
  66                                       in double Xaxis, in double Yaxis, in double Zaxis, in double Angle,
  67                                       in double Xcentre, in double Ycentre, in double Zcentre)
  68                                                            raises (SALOME::SALOME_Exception);
  69     HOMARD_Cas        CreateCase(in string CaseName, in string MeshName, in string FileName )
  70                                                            raises (SALOME::SALOME_Exception);
  71     HOMARD_Hypothesis CreateHypothesis(in string HypoName )
  72                                                            raises (SALOME::SALOME_Exception);
  73     HOMARD_Zone       CreateZoneBox (in string ZoneName,
  74                                      in double Xmini, in double Xmaxi,
  75                                      in double Ymini, in double Ymaxi,
  76                                      in double Zmini, in double Zmaxi)
  77                                                            raises (SALOME::SALOME_Exception);
  78     HOMARD_Zone       CreateZoneBox2D (in string ZoneName,
  79                                        in double Umini, in double Umaxi,
  80                                        in double Vmini, in double Vmaxi,
  81                                        in long Orient)
  82                                                            raises (SALOME::SALOME_Exception);
  83     HOMARD_Zone       CreateZoneCylinder (in string ZoneName,
  84                                           in double Xcentre, in double Ycentre, in double Zcentre,
  85                                           in double Xaxis, in double Yaxis, in double Zaxis,
  86                                           in double Radius, in double Height)
  87                                                            raises (SALOME::SALOME_Exception);
  88     HOMARD_Zone       CreateZoneDisk (in string ZoneName,
  89                                       in double Ucentre, in double Vcentre,
  90                                       in double Radius, in long Orient)
  91                                                            raises (SALOME::SALOME_Exception);
  92     HOMARD_Zone       CreateZoneDiskWithHole (in string ZoneName,
  93                                               in double Ucentre, in double Vcentre,
  94                                               in double Radius, in double InternalRadius,
  95                                               in long Orient)
  96                                                            raises (SALOME::SALOME_Exception);
  97     HOMARD_Zone       CreateZonePipe (in string ZoneName,
  98                                       in double Xcentre, in double Ycentre, in double Zcentre,
  99                                       in double Xaxis, in double Yaxis, in double Zaxis,
 100                                       in double Radius, in double Height, in double InternalRadius)
 101                                                            raises (SALOME::SALOME_Exception);
 102     HOMARD_Zone       CreateZoneSphere (in string ZoneName,
 103                                         in double Xcentre, in double Ycentre, in double Zcentre,
 104                                         in double Radius)
 105                                                            raises (SALOME::SALOME_Exception);
 106 //
 107 // A.2. Les informations
 108 //
 109     HOMARD_Boundary   GetBoundary(in string BoundaryName)  raises (SALOME::SALOME_Exception);
 110     HOMARD_Cas        GetCase(in string CaseName)          raises (SALOME::SALOME_Exception);
 111     HOMARD_Hypothesis GetHypothesis(in string HypoName)    raises (SALOME::SALOME_Exception);
 112     HOMARD_Iteration  GetIteration(in string IterName)     raises (SALOME::SALOME_Exception);
 113     HOMARD_Zone       GetZone(in string ZoneName)          raises (SALOME::SALOME_Exception);
 114
 115     listeBoundarys  GetAllBoundarysName()                  raises (SALOME::SALOME_Exception);
 116     listeCases      GetAllCasesName()                      raises (SALOME::SALOME_Exception);
 117     listeHypotheses GetAllHypothesesName()                 raises (SALOME::SALOME_Exception);
 118     listeIterations GetAllIterationsName()                 raises (SALOME::SALOME_Exception);
 119     listeZones      GetAllZonesName()                      raises (SALOME::SALOME_Exception);
 120
 121     void            MeshInfo(in string CaseName, in string MeshName, in string FileName,  in string DirName, in long Qual, in long Diam, in long Conn, in long Tail, in long Inte )
 122                                                            raises (SALOME::SALOME_Exception);
 123
 124     HOMARD_Iteration LastIteration(in string CaseName)     raises (SALOME::SALOME_Exception);
 125 //
 126 // A.3. L'etude
 127 //
 128     void     SetCurrentStudy(in SALOMEDS::Study theStudy)  raises (SALOME::SALOME_Exception);
 129     SALOMEDS::Study GetCurrentStudy()                      raises (SALOME::SALOME_Exception);
 130     long     GetCurrentStudyID()                           raises (SALOME::SALOME_Exception);
 131 //
 132 // B. Les methodes qui suivent n'apparaissent pas dans le composant HOMARD dans YACS
 133 //    L'utilisateur ne devrait pas les connaitre (ni s'en servir, a fortiori)
 134 //
 135     HOMARD_Iteration  CreateIteration(in string IterName, in string PreviousIterName )
 136                                                            raises (SALOME::SALOME_Exception);
 137 //
 138     void InvalideBoundary (in string BoundaryName)         raises (SALOME::SALOME_Exception);
 139     void InvalideHypo (in string HypoName)                 raises (SALOME::SALOME_Exception);
 140     void InvalideIter (in string IterName)                 raises (SALOME::SALOME_Exception);
 141     void InvalideIterOption (in string IterName, in long Option)
 142                                                            raises (SALOME::SALOME_Exception);
 143     void InvalideZone (in string ZoneName)                 raises (SALOME::SALOME_Exception);
 144
 145     long DeleteBoundary (in string BoundaryName)           raises (SALOME::SALOME_Exception);
 146     long DeleteCase(in string CaseName)                    raises (SALOME::SALOME_Exception);
 147     long DeleteHypo(in string HypoName)                    raises (SALOME::SALOME_Exception);
 148     long DeleteIteration(in string IterName, in long Option)
 149                                                            raises (SALOME::SALOME_Exception);
 150     long DeleteIterationOption(in string IterName, in long Option1, in long Option2)
 151                                                            raises (SALOME::SALOME_Exception);
 152     long DeleteZone (in string ZoneName)                   raises (SALOME::SALOME_Exception);
 153 //
 154     void AssociateIterHypo(in string IterName, in string HypoName)
 155                                                            raises (SALOME::SALOME_Exception);
 156
 157 //
 158     void AssociateHypoZone(in string HypoName, in string ZoneName, in long TypeUse)
 159                                                            raises (SALOME::SALOME_Exception);
 160     void DissociateHypoZone(in string HypoName, in string ZoneName)
 161                                                            raises (SALOME::SALOME_Exception);
 162
 163     long Compute (in string IterName, in long CleanOption, in long modeHOMARD, in long Option)
 164                                                            raises (SALOME::SALOME_Exception);
 165
 166     boolean  VerifieDir (in string IterName)               raises (SALOME::SALOME_Exception);
 167
 168     void  PublishFileUnderIteration(in string IterName, in string FileName, in string Comment)
 169                                                            raises (SALOME::SALOME_Exception);
 170     void  PublishBoundaryUnderCase(in string CaseName, in string BoundaryName);
 171     void  PublishResultInSmesh(in string FileName, in long Option)
 172                                                            raises (SALOME::SALOME_Exception);
 173
 174   };
 175 };
 176
 177 #endif
 178