idl/HOMARD_Zone.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 // Remarques :
  20 // L'ordre de description des fonctions est le meme dans tous les fichiers
  21 // HOMARD_aaaa.idl, HOMARD_aaaa.hxx, HOMARD_aaaa.cxx, HOMARD_aaaa_i.hxx, HOMARD_aaaa_i.cxx :
  22 // 1. Les generalites : Name, Delete, DumpPython, Dump, Restore
  23 // 2. Les caracteristiques
  24 // 3. Le lien avec les autres structures
  25 //
  26 // Quand les 2 fonctions Setxxx et Getxxx sont presentes, Setxxx est decrit en premier
  27 //
  28
  29 #ifndef _HOMARD_Zone_IDL
  30 #define _HOMARD_Zone_IDL
  31
  32 #include "SALOME_Component.idl"
  33 #include "SALOME_Exception.idl"
  34 #include "SALOMEDS.idl"
  35
  36 module HOMARD
  37 {
  38   typedef sequence<double    > double_array ;
  39   typedef sequence<string    > listeHypo ;
  40
  41   interface HOMARD_Zone : Engines::EngineComponent
  42   {
  43 // Generalites
  44     void     SetName(in string Name)                       raises (SALOME::SALOME_Exception);
  45     string   GetName()                                     raises (SALOME::SALOME_Exception);
  46
  47     long     Delete()                                      raises (SALOME::SALOME_Exception);
  48
  49     string   GetDumpPython()                               raises (SALOME::SALOME_Exception);
  50
  51 // Caracteristiques
  52     void     SetType (in long Type)                        raises (SALOME::SALOME_Exception);
  53     long     GetType()                                     raises (SALOME::SALOME_Exception);
  54
  55     void     SetBox    (in double Xmini, in double Xmaxi, in double Ymini,
  56                         in double Ymaxi, in double Zmini, in double Zmaxi)
  57                                                            raises (SALOME::SALOME_Exception);
  58     void     SetCylinder (in double Xcentre, in double Ycentre, in double Zcentre,
  59                           in double Xaxis, in double Yaxis, in double Zaxis,
  60                           in double Rayon, in double Haut)
  61                                                            raises (SALOME::SALOME_Exception);
  62     void     SetPipe( in double Xcentre, in double Ycentre, in double ZCentre,
  63                       in double Xaxis, in double Yaxis, in double Zaxis,
  64                       in double Rayon, in double Haut, in double Rayonint )
  65                                                            raises (SALOME::SALOME_Exception);
  66     void     SetSphere (in double Xcentre, in double Ycentre, in double Zcentre, in double rayon)
  67                                                            raises (SALOME::SALOME_Exception);
  68
  69     double_array GetCoords()                               raises (SALOME::SALOME_Exception);
  70
  71     void     SetLimit (in double Xincr, in double Yincr, in double Zincr)
  72                                                            raises (SALOME::SALOME_Exception);
  73     double_array GetLimit()                                raises (SALOME::SALOME_Exception);
  74
  75 // Liens avec les autres structures
  76     void     AddHypo(in string NomHypo)                    raises (SALOME::SALOME_Exception);
  77     listeHypo GetHypo()                                    raises (SALOME::SALOME_Exception);
  78     void     SupprHypo(in string NomHypo)                  raises (SALOME::SALOME_Exception);
  79
  80   };
  81 };
  82 #endif