idl/HOMARD_Gen.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
  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_Cas        CreateCase(in string CaseName, in string MeshName, in string FileName )
  51                                                            raises (SALOME::SALOME_Exception);
  52     HOMARD_Hypothesis CreateHypothesis(in string HypoName )
  53                                                            raises (SALOME::SALOME_Exception);
  54     HOMARD_Zone       CreateZoneBox (in string ZoneName,
  55                                      in double Xmini, in double Xmaxi,
  56                                      in double Ymini, in double Ymaxi,
  57                                      in double Zmini, in double Zmaxi)
  58                                                            raises (SALOME::SALOME_Exception);
  59     HOMARD_Zone       CreateZoneSphere (in string ZoneName,
  60                                         in double Xcentre, in double Ycentre, in double Zcentre,
  61                                         in double Radius)
  62                                                            raises (SALOME::SALOME_Exception);
  63     HOMARD_Zone       CreateZoneCylinder (in string ZoneName,
  64                                           in double Xcentre, in double Ycentre, in double Zcentre,
  65                                           in double Xaxis, in double Yaxis, in double Zaxis,
  66                                           in double Radius, in double Height)
  67                                                            raises (SALOME::SALOME_Exception);
  68     HOMARD_Zone       CreateZonePipe (in string ZoneName,
  69                                       in double Xcentre, in double Ycentre, in double Zcentre,
  70                                       in double Xaxis, in double Yaxis, in double Zaxis,
  71                                       in double Radius, in double Height, in double InternalRadius)
  72                                                            raises (SALOME::SALOME_Exception);
  73     HOMARD_Zone       CreateZoneBox2D (in string ZoneName,
  74                                        in double Umini, in double Umaxi,
  75                                        in double Vmini, in double Vmaxi,
  76                                        in long Orient)
  77                                                            raises (SALOME::SALOME_Exception);
  78     HOMARD_Zone       CreateZoneDisk (in string ZoneName,
  79                                       in double Ucentre, in double Vcentre,
  80                                       in double Radius, in long Orient)
  81                                                            raises (SALOME::SALOME_Exception);
  82     HOMARD_Zone       CreateZoneDiskWithHole (in string ZoneName,
  83                                               in double Ucentre, in double Vcentre,
  84                                               in double Radius, in double InternalRadius,
  85                                               in long Orient)
  86                                                            raises (SALOME::SALOME_Exception);
  87     HOMARD_Boundary   CreateBoundaryDi (in string BounName, in string MeshName, in string FileName)
  88                                                            raises (SALOME::SALOME_Exception);
  89     HOMARD_Boundary   CreateBoundaryCylinder (in string BounName,
  90                                       in double Xcentre, in double Ycentre, in double Zcentre,
  91                                       in double Xaxis, in double Yaxis, in double Zaxis,
  92                                       in double Radius)
  93                                                            raises (SALOME::SALOME_Exception);
  94     HOMARD_Boundary   CreateBoundarySphere (in string BounName,
  95                                       in double Xcentre, in double Ycentre, in double Zcentre,
  96                                       in double Radius)
  97                                                            raises (SALOME::SALOME_Exception);
  98 //
  99 // A.2. Les informations
 100 //
 101     HOMARD_Cas        GetCase(in string CaseName)          raises (SALOME::SALOME_Exception);
 102     HOMARD_Boundary   GetBoundary(in string BounName)      raises (SALOME::SALOME_Exception);
 103     HOMARD_Zone       GetZone(in string ZoneName)          raises (SALOME::SALOME_Exception);
 104     HOMARD_Hypothesis GetHypothesis(in string HypoName)    raises (SALOME::SALOME_Exception);
 105     HOMARD_Iteration  GetIteration(in string IterName)     raises (SALOME::SALOME_Exception);
 106
 107     listeCases      GetAllCasesName()                      raises (SALOME::SALOME_Exception);
 108     listeBoundarys  GetAllBoundarysName()                  raises (SALOME::SALOME_Exception);
 109     listeHypotheses GetAllHypothesesName()                 raises (SALOME::SALOME_Exception);
 110     listeZones      GetAllZonesName()                      raises (SALOME::SALOME_Exception);
 111     listeIterations GetAllIterationsName()                 raises (SALOME::SALOME_Exception);
 112 //
 113 // A.3. L'etude
 114 //
 115     void     SetCurrentStudy(in SALOMEDS::Study theStudy)  raises (SALOME::SALOME_Exception);
 116 //
 117 // B. Les methodes qui suivent n'apparaissent pas dans le composant HOMARD dans YACS
 118 //    L'utilisateur ne devrait pas les connaitre (ni s'en servir, a fortiori)
 119 //
 120     HOMARD_Iteration  CreateIteration(in string IterName, in string PreviousIterName )
 121                                                            raises (SALOME::SALOME_Exception);
 122 //
 123     void AssociateIterHypo(in string IterName, in string HypoName)
 124                                                            raises (SALOME::SALOME_Exception);
 125
 126 //
 127     void DissociateHypoZone(in string ZoneName, in string HypoName)
 128                                                            raises (SALOME::SALOME_Exception);
 129
 130     void InvalideBoundary (in string BounName)             raises (SALOME::SALOME_Exception);
 131     void InvalideZone (in string ZoneName)                 raises (SALOME::SALOME_Exception);
 132     void InvalideHypo (in string HypoName)                 raises (SALOME::SALOME_Exception);
 133     void InvalideIter (in string IterName)                 raises (SALOME::SALOME_Exception);
 134
 135     long Compute (in string IterName, in long etatMenage)  raises (SALOME::SALOME_Exception);
 136
 137     boolean  VerifieDir (in string IterName)               raises (SALOME::SALOME_Exception);
 138
 139     void  PublishFileUnderIteration(in string NomIter, in string NomFich, in string Commentaire)
 140                                                            raises (SALOME::SALOME_Exception);
 141     void  PublishResultInSmesh(in string NomFich, in long IconeType)
 142                                                            raises (SALOME::SALOME_Exception);
 143
 144     SALOMEDS::Study GetCurrentStudy()                      raises (SALOME::SALOME_Exception);
 145     long     GetCurrentStudyID()                           raises (SALOME::SALOME_Exception);
 146   };
 147 };
 148
 149 #endif
 150