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 #include "HOMARD_YACS.idl"
  33
  34 module HOMARD
  35 {
  36   typedef sequence<string> listeHypotheses;
  37   typedef sequence<string> listeZones;
  38   typedef sequence<string> listeIterations;
  39   typedef sequence<string> listeCases;
  40   typedef sequence<string> listeBoundarys;
  41   typedef sequence<string> listeYACSs;
  42
  43   interface HOMARD_Gen : Engines::EngineComponent, SALOMEDS::Driver
  44   {
  45 //
  46 // A. Les methodes qui suivent sont celles que l'on retrouvera dans
  47 //    le fichier resources/HOMARDCatalog.xml.in pour definir le composant HOMARD dans YACS
  48 //    A priori, ce sont les seules sont l'utilisateur doit connaitre l'existence.
  49 //    ATTENTION : si les noms des arguments changent dans les Createxxxx, il faudra les changer
  50 //                dans YACSDriver pour assurer la coherence
  51 //
  52 // A.1. Les creations
  53 //
  54     HOMARD_Boundary   CreateBoundaryDi (in string BoundaryName, in string MeshName, in string FileName)
  55     raises(SALOME::SALOME_Exception);
  56     HOMARD_Boundary   CreateBoundaryCylinder (in string BoundaryName,
  57                                       in double Xcentre, in double Ycentre, in double Zcentre,
  58                                       in double Xaxis, in double Yaxis, in double Zaxis,
  59                                       in double Radius)
  60     raises (SALOME::SALOME_Exception);
  61     HOMARD_Boundary   CreateBoundarySphere (in string BoundaryName,
  62                                       in double Xcentre, in double Ycentre, in double Zcentre,
  63                                       in double Radius)
  64     raises(SALOME::SALOME_Exception);
  65     HOMARD_Boundary   CreateBoundaryConeR (in string BoundaryName,
  66                                       in double Xcentre1, in double Ycentre1, in double Zcentre1, in double Radius1,
  67                                       in double Xcentre2, in double Ycentre2, in double Zcentre2, in double Radius2)
  68     raises(SALOME::SALOME_Exception);
  69     HOMARD_Boundary   CreateBoundaryConeA (in string BoundaryName,
  70                                       in double Xaxis, in double Yaxis, in double Zaxis, in double Angle,
  71                                       in double Xcentre, in double Ycentre, in double Zcentre)
  72     raises(SALOME::SALOME_Exception);
  73     HOMARD_Boundary   CreateBoundaryTorus (in string BoundaryName,
  74                                       in double Xcentre, in double Ycentre, in double Zcentre,
  75                                       in double Xaxis, in double Yaxis, in double Zaxis,
  76                                       in double RadiusRev, in double RadiusPri)
  77     raises (SALOME::SALOME_Exception);
  78     HOMARD_Cas        CreateCase(in string CaseName, in string MeshName, in string FileName )
  79     raises(SALOME::SALOME_Exception);
  80     HOMARD_Cas        CreateCaseFromIteration(in string CaseName, in string DirNameStart )
  81     raises(SALOME::SALOME_Exception);
  82     HOMARD_Cas        CreateCaseFromCaseLastIteration(in string CaseName, in string DirNameStart )
  83     raises(SALOME::SALOME_Exception);
  84     HOMARD_Cas        CreateCaseFromCaseIteration(in string CaseName, in string DirNameStart, in long Number )
  85     raises(SALOME::SALOME_Exception);
  86     HOMARD_Hypothesis CreateHypothesis(in string HypoName )
  87     raises(SALOME::SALOME_Exception);
  88     HOMARD_Zone       CreateZoneBox (in string ZoneName,
  89                                      in double Xmini, in double Xmaxi,
  90                                      in double Ymini, in double Ymaxi,
  91                                      in double Zmini, in double Zmaxi)
  92     raises(SALOME::SALOME_Exception);
  93     HOMARD_Zone       CreateZoneBox2D (in string ZoneName,
  94                                        in double Umini, in double Umaxi,
  95                                        in double Vmini, in double Vmaxi,
  96                                        in long Orient)
  97     raises(SALOME::SALOME_Exception);
  98     HOMARD_Zone       CreateZoneCylinder (in string ZoneName,
  99                                           in double Xcentre, in double Ycentre, in double Zcentre,
 100                                           in double Xaxis, in double Yaxis, in double Zaxis,
 101                                           in double Radius, in double Height)
 102     raises(SALOME::SALOME_Exception);
 103     HOMARD_Zone       CreateZoneDisk (in string ZoneName,
 104                                       in double Ucentre, in double Vcentre,
 105                                       in double Radius, in long Orient)
 106     raises(SALOME::SALOME_Exception);
 107     HOMARD_Zone       CreateZoneDiskWithHole (in string ZoneName,
 108                                               in double Ucentre, in double Vcentre,
 109                                               in double Radius, in double InternalRadius,
 110                                               in long Orient)
 111     raises(SALOME::SALOME_Exception);
 112     HOMARD_Zone       CreateZonePipe (in string ZoneName,
 113                                       in double Xcentre, in double Ycentre, in double Zcentre,
 114                                       in double Xaxis, in double Yaxis, in double Zaxis,
 115                                       in double Radius, in double Height, in double InternalRadius)
 116     raises(SALOME::SALOME_Exception);
 117     HOMARD_Zone       CreateZoneSphere (in string ZoneName,
 118                                         in double Xcentre, in double Ycentre, in double Zcentre,
 119                                         in double Radius)
 120     raises(SALOME::SALOME_Exception);
 121 //
 122 // A.2. Les informations
 123 //
 124     HOMARD_Boundary   GetBoundary(in string BoundaryName)  raises (SALOME::SALOME_Exception);
 125     HOMARD_Cas        GetCase(in string CaseName)          raises (SALOME::SALOME_Exception);
 126     HOMARD_Hypothesis GetHypothesis(in string HypoName)    raises (SALOME::SALOME_Exception);
 127     HOMARD_Iteration  GetIteration(in string IterName)     raises (SALOME::SALOME_Exception);
 128     HOMARD_YACS       GetYACS(in string YACSName)          raises (SALOME::SALOME_Exception);
 129     HOMARD_Zone       GetZone(in string ZoneName)          raises (SALOME::SALOME_Exception);
 130
 131     listeBoundarys  GetAllBoundarysName()                  raises (SALOME::SALOME_Exception);
 132     listeCases      GetAllCasesName()                      raises (SALOME::SALOME_Exception);
 133     listeHypotheses GetAllHypothesesName()                 raises (SALOME::SALOME_Exception);
 134     listeIterations GetAllIterationsName()                 raises (SALOME::SALOME_Exception);
 135     listeYACSs      GetAllYACSsName()                      raises (SALOME::SALOME_Exception);
 136     listeZones      GetAllZonesName()                      raises (SALOME::SALOME_Exception);
 137
 138     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 )
 139     raises(SALOME::SALOME_Exception);
 140
 141     HOMARD_Iteration LastIteration(in string CaseName)     raises (SALOME::SALOME_Exception);
 142 //
 143 // A.3. L'etude
 144 //
 145     void SetCurrentStudy(in SALOMEDS::Study theStudy)      raises (SALOME::SALOME_Exception);
 146     SALOMEDS::Study GetCurrentStudy()                      raises (SALOME::SALOME_Exception);
 147     long GetCurrentStudyID()                               raises (SALOME::SALOME_Exception);
 148 //
 149 // B. Les methodes qui suivent n'apparaissent pas dans le composant HOMARD dans YACS
 150 //    L'utilisateur ne devrait pas les connaitre (ni s'en servir, a fortiori)
 151 //
 152     HOMARD_Iteration CreateIteration(in string IterName, in string PreviousIterName )
 153     raises(SALOME::SALOME_Exception);
 154 //
 155     void InvalideBoundary (in string BoundaryName)         raises (SALOME::SALOME_Exception);
 156     void InvalideHypo (in string HypoName)                 raises (SALOME::SALOME_Exception);
 157     void InvalideIter (in string IterName)                 raises (SALOME::SALOME_Exception);
 158     void InvalideIterOption (in string IterName, in long Option)
 159     raises(SALOME::SALOME_Exception);
 160     void InvalideZone (in string ZoneName)                 raises (SALOME::SALOME_Exception);
 161
 162     long DeleteBoundary (in string BoundaryName)           raises (SALOME::SALOME_Exception);
 163     long DeleteCase(in string CaseName, in long Option)
 164     raises(SALOME::SALOME_Exception);
 165     long DeleteHypo(in string HypoName)                    raises (SALOME::SALOME_Exception);
 166     long DeleteIteration(in string IterName, in long Option)
 167     raises(SALOME::SALOME_Exception);
 168     long DeleteIterationOption(in string IterName, in long Option1, in long Option2)
 169     raises(SALOME::SALOME_Exception);
 170     long DeleteYACS(in string YacsName, in long Option)    raises (SALOME::SALOME_Exception);
 171     long DeleteZone (in string ZoneName)                   raises (SALOME::SALOME_Exception);
 172 //
 173     void AssociateIterHypo(in string IterName, in string HypoName)
 174     raises(SALOME::SALOME_Exception);
 175
 176 //
 177     void AssociateHypoZone(in string HypoName, in string ZoneName, in long TypeUse)
 178     raises(SALOME::SALOME_Exception);
 179     void DissociateHypoZone(in string HypoName, in string ZoneName)
 180     raises(SALOME::SALOME_Exception);
 181
 182     long Compute (in string IterName, in long CleanOption, in long modeHOMARD, in long Option1, in long Option2)
 183     raises(SALOME::SALOME_Exception);
 184
 185 //
 186     string CreateDirNameIter(in string NomDir, in long option )
 187     raises(SALOME::SALOME_Exception);
 188
 189     string VerifieDir (in string NomDir)                   raises (SALOME::SALOME_Exception);
 190
 191 //
 192     void PublishFileUnderIteration(in string IterName, in string FileName, in string Comment)
 193     raises(SALOME::SALOME_Exception);
 194     void PublishBoundaryUnderCase(in string CaseName, in string BoundaryName)
 195     raises(SALOME::SALOME_Exception);
 196     void PublishResultInSmesh(in string FileName, in long Option)
 197     raises(SALOME::SALOME_Exception);
 198     void PublishMeshIterInSmesh (in string IterName)       raises(SALOME::SALOME_Exception);
 199
 200 //
 201
 202 //
 203     HOMARD_YACS CreateYACSSchema(in string YACSName, in string CaseName, in string ScriptFile, in string DirName, in string MeshFile)
 204     raises(SALOME::SALOME_Exception);
 205     long YACSWrite (in string YACSName)                    raises (SALOME::SALOME_Exception);
 206     long YACSWriteOnFile (in string YACSName, in string YACSFile)
 207     raises(SALOME::SALOME_Exception);
 208
 209 //
 210     void SetLanguageShort (in string LanguageShort)        raises (SALOME::SALOME_Exception);
 211     string GetLanguageShort ()                             raises (SALOME::SALOME_Exception);
 212     void SetPublisMesh (in long PublisMeshIN, in long PublisMeshOUT)
 213     raises (SALOME::SALOME_Exception);
 214     long GetPublisMeshIN ()                                raises (SALOME::SALOME_Exception);
 215     long GetPublisMeshOUT ()                               raises (SALOME::SALOME_Exception);
 216   };
 217 };
 218
 219 #endif
 220