Salome HOME
Copyright update 2022
[modules/homard.git] / idl / HOMARD_Zone.idl
index 1ae7aaec06875d9e29610c55e63df2586e0ace93..b5ba50fea0f6f9246e242f1542f84ca42d0da7fd 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_Zone_IDL
 #define _HOMARD_Zone_IDL
 
@@ -31,18 +41,21 @@ module HOMARD
 
   interface HOMARD_Zone : Engines::EngineComponent
   {
+// Generalites
+    void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
+    string   GetName()                                     raises (SALOME::SALOME_Exception);
+
+    long     Delete()                                      raises (SALOME::SALOME_Exception);
 
-    void     SetName (in string NomZone)                   raises (SALOME::SALOME_Exception);
-    string   GetName ()                                    raises (SALOME::SALOME_Exception);
+    string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
 
-    void     SetZoneType (in long ZoneType)                raises (SALOME::SALOME_Exception);
-    long     GetZoneType()                                 raises (SALOME::SALOME_Exception);
+// Caracteristiques
+    void     SetType (in long Type)                        raises (SALOME::SALOME_Exception);
+    long     GetType()                                     raises (SALOME::SALOME_Exception);
 
     void     SetBox    (in double Xmini, in double Xmaxi, in double Ymini,
                         in double Ymaxi, in double Zmini, in double Zmaxi)
                                                            raises (SALOME::SALOME_Exception);
-    void     SetSphere (in double Xcentre, in double Ycentre, in double Zcentre, in double rayon)
-                                                           raises (SALOME::SALOME_Exception);
     void     SetCylinder (in double Xcentre, in double Ycentre, in double Zcentre,
                           in double Xaxis, in double Yaxis, in double Zaxis,
                           in double Rayon, in double Haut)
@@ -51,16 +64,19 @@ module HOMARD
                       in double Xaxis, in double Yaxis, in double Zaxis,
                       in double Rayon, in double Haut, in double Rayonint )
                                                            raises (SALOME::SALOME_Exception);
+    void     SetSphere (in double Xcentre, in double Ycentre, in double Zcentre, in double rayon)
+                                                           raises (SALOME::SALOME_Exception);
+
     double_array GetCoords()                               raises (SALOME::SALOME_Exception);
+
     void     SetLimit (in double Xincr, in double Yincr, in double Zincr)
                                                            raises (SALOME::SALOME_Exception);
     double_array GetLimit()                                raises (SALOME::SALOME_Exception);
 
+// Liens avec les autres structures
     void     AddHypo(in string NomHypo)                    raises (SALOME::SALOME_Exception);
-    void     SupprHypo(in string NomHypo)                  raises (SALOME::SALOME_Exception);
     listeHypo GetHypo()                                    raises (SALOME::SALOME_Exception);
-
-    string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
+    void     SupprHypo(in string NomHypo)                  raises (SALOME::SALOME_Exception);
 
   };
 };