Salome HOME
Copyright update 2022
[modules/homard.git] / idl / HOMARD_Hypothesis.idl
index 7ff0b81ba13f9be6cbd57c35894a23f7ef4e3218..fe4d6a5019b1ac1f79b02f1a07be49918e35dca1 100644 (file)
@@ -1,9 +1,9 @@
-// Copyright (C) 2011-2012  CEA/DEN, EDF R&D
+// Copyright (C) 2011-2022  CEA/DEN, EDF R&D
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
+// Remarques :
+// L'ordre de description des fonctions est le meme dans tous les fichiers
+// HOMARD_aaaa.idl, HOMARD_aaaa.hxx, HOMARD_aaaa.cxx, HOMARD_aaaa_i.hxx, HOMARD_aaaa_i.cxx :
+// 1. Les generalites : Name, Delete, DumpPython, Dump, Restore
+// 2. Les caracteristiques
+// 3. Le lien avec les autres structures
+//
+// Quand les 2 fonctions Setxxx et Getxxx sont presentes, Setxxx est decrit en premier
+//
+
 #ifndef _HOMARD_HYPOTHESIS_IDL
 #define _HOMARD_HYPOTHESIS_IDL
 
@@ -31,8 +41,8 @@ module HOMARD
   typedef sequence<string> listeZonesHypo ;
   typedef sequence<string> listeIters ;
   typedef sequence<string> listeComposantsHypo ;
-  typedef sequence<long>   listeTypes;
-  typedef sequence<string> listFieldInterpHypo;
+  typedef sequence<long>   listeTypes ;
+  typedef sequence<string> listeFieldInterpsHypo ;
 
   struct InfosHypo
   {
@@ -47,52 +57,38 @@ module HOMARD
 
   interface HOMARD_Hypothesis : Engines::EngineComponent
   {
-
-    void     SetName(in string NomHypothesis)              raises (SALOME::SALOME_Exception);
+// Generalites
+    void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
     string   GetName()                                     raises (SALOME::SALOME_Exception);
 
-    void     SetCaseCreation(in string NomCas)             raises (SALOME::SALOME_Exception);
-    string   GetCaseCreation()                             raises (SALOME::SALOME_Exception);
+    long     Delete()                                      raises (SALOME::SALOME_Exception);
 
-    void       SetAdapRefinUnRef(in long Adap, in long Raff, in long Dera)
-                                                           raises (SALOME::SALOME_Exception);
-    listeTypes GetAdapRefinUnRef()                         raises (SALOME::SALOME_Exception);
-    long       GetAdapType()                               raises (SALOME::SALOME_Exception);
-    long       GetRefinType()                              raises (SALOME::SALOME_Exception);
-    long       GetUnRefType()                              raises (SALOME::SALOME_Exception);
+    string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
 
-    void       SetField(in string FieldName)               raises (SALOME::SALOME_Exception);
-    string     GetFieldName()                              raises (SALOME::SALOME_Exception);
-    void       SetRefinThr(in long TypeThR, in double ThreshR)
+// Caracteristiques
+    void     SetUnifRefinUnRef(in long RaffDera)           raises (SALOME::SALOME_Exception);
+    listeTypes GetAdapRefinUnRef()                         raises (SALOME::SALOME_Exception);
+    long     GetAdapType()                                 raises (SALOME::SALOME_Exception);
+    long     GetRefinType()                                raises (SALOME::SALOME_Exception);
+    long     GetUnRefType()                                raises (SALOME::SALOME_Exception);
+
+    void     SetField(in string FieldName)                 raises (SALOME::SALOME_Exception);
+    string   GetFieldName()                                raises (SALOME::SALOME_Exception);
+    void     SetUseField(in long UsField)                  raises (SALOME::SALOME_Exception);
+    InfosHypo GetField()                                   raises (SALOME::SALOME_Exception);
+
+    void     SetUseComp(in long UsCmpI)                    raises (SALOME::SALOME_Exception);
+    void     AddComp(in string NomComp)                    raises (SALOME::SALOME_Exception);
+    void     SupprComp(in string NomComp)                  raises (SALOME::SALOME_Exception);
+    void     SupprComps()                                  raises (SALOME::SALOME_Exception);
+    listeComposantsHypo GetComps()                         raises (SALOME::SALOME_Exception);
+
+    void     SetRefinThr(in long TypeThR, in double ThreshR)
                                                            raises (SALOME::SALOME_Exception);
-    void       SetUnRefThr(in long TypeThC, in double ThreshC)
+    long     GetRefinThrType()                             raises (SALOME::SALOME_Exception);
+    void     SetUnRefThr(in long TypeThC, in double ThreshC)
                                                            raises (SALOME::SALOME_Exception);
-    long       GetRefinThrType()                           raises (SALOME::SALOME_Exception);
-    long       GetUnRefThrType()                           raises (SALOME::SALOME_Exception);
-    void       SetUseComp(in long UsCmpI)                  raises (SALOME::SALOME_Exception);
-    void       SetUseField(in long UsField)                raises (SALOME::SALOME_Exception);
-    InfosHypo  GetField()                                  raises (SALOME::SALOME_Exception);
-
-    void       AddComp(in string NomComposant)             raises (SALOME::SALOME_Exception);
-    void       SupprComp()                                 raises (SALOME::SALOME_Exception);
-    listeComposantsHypo GetListComp()                      raises (SALOME::SALOME_Exception);
-
-    void       AddZone(in string NomZone, in long TypeUse) raises (SALOME::SALOME_Exception);
-    void       SupprZone(in string NomZone)                raises (SALOME::SALOME_Exception);
-    listeZonesHypo GetZones()                              raises (SALOME::SALOME_Exception);
-
-    listeIters GetIterations()                             raises (SALOME::SALOME_Exception);
-    void       AddIteration(in string NomIteration)        raises (SALOME::SALOME_Exception);
-
-    ListGroupType GetGroups()                              raises (SALOME::SALOME_Exception);
-    void       SetGroups(in ListGroupType ListGroup)       raises (SALOME::SALOME_Exception);
-    void       AddGroup(in string LeGroupe)                raises (SALOME::SALOME_Exception);
-
-    void       SetTypeFieldInterp(in long TypeFieldInterp) raises (SALOME::SALOME_Exception);
-    long       GetTypeFieldInterp()                        raises (SALOME::SALOME_Exception);
-    void       AddFieldInterp(in string FieldInterp)       raises (SALOME::SALOME_Exception);
-    void       SupprFieldInterp()                          raises (SALOME::SALOME_Exception);
-    listFieldInterpHypo GetListFieldInterp()               raises (SALOME::SALOME_Exception);
+    long     GetUnRefThrType()                             raises (SALOME::SALOME_Exception);
 
     void     SetNivMax(in long NivMax)                     raises (SALOME::SALOME_Exception);
     long     GetNivMax()                                   raises (SALOME::SALOME_Exception);
@@ -103,7 +99,37 @@ module HOMARD
     void     SetAdapInit(in long AdapInit)                 raises (SALOME::SALOME_Exception);
     long     GetAdapInit()                                 raises (SALOME::SALOME_Exception);
 
-    string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
+    void     SetExtraOutput(in long ExtraOutput)           raises (SALOME::SALOME_Exception);
+    long     GetExtraOutput()                              raises (SALOME::SALOME_Exception);
+
+    void     AddGroup(in string LeGroupe)                  raises (SALOME::SALOME_Exception);
+    void     SupprGroup(in string LeGroupe)                raises (SALOME::SALOME_Exception);
+    void     SupprGroups()                                 raises (SALOME::SALOME_Exception);
+    void     SetGroups(in ListGroupType ListGroup)         raises (SALOME::SALOME_Exception);
+    ListGroupType GetGroups()                              raises (SALOME::SALOME_Exception);
+
+    void     SetTypeFieldInterp(in long TypeFieldInterp)   raises (SALOME::SALOME_Exception);
+    long     GetTypeFieldInterp()                          raises (SALOME::SALOME_Exception);
+    void     AddFieldInterp(in string FieldInterp)         raises (SALOME::SALOME_Exception);
+    void     AddFieldInterpType(in string FieldInterp, in long TypeInterp)
+                                                           raises (SALOME::SALOME_Exception);
+    void     SupprFieldInterp(in string FieldInterp)       raises (SALOME::SALOME_Exception);
+    void     SupprFieldInterps()                           raises (SALOME::SALOME_Exception);
+    listeFieldInterpsHypo GetFieldInterps()                raises (SALOME::SALOME_Exception);
+
+// Liens avec les autres structures
+    void     SetCaseCreation(in string NomCas)             raises (SALOME::SALOME_Exception);
+    string   GetCaseCreation()                             raises (SALOME::SALOME_Exception);
+
+    void     LinkIteration(in string NomIteration)         raises (SALOME::SALOME_Exception);
+    void     UnLinkIteration(in string NomIteration)       raises (SALOME::SALOME_Exception);
+    listeIters GetIterations()                             raises (SALOME::SALOME_Exception);
+
+    void     AddZone(in string NomZone, in long TypeUse)   raises (SALOME::SALOME_Exception);
+    void     AddZone0(in string NomZone, in long TypeUse)  raises (SALOME::SALOME_Exception);
+    void     SupprZone(in string NomZone)                  raises (SALOME::SALOME_Exception);
+    void     SupprZones()                                  raises (SALOME::SALOME_Exception);
+    listeZonesHypo GetZones()                              raises (SALOME::SALOME_Exception);
 
   };
 };