idl/HELLO_Gen.idl

   1 // Copyright (C) 2005  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 #ifndef __HELLO_GEN__
  20 #define __HELLO_GEN__
  21 /*!
  22  \defgroup EXAMPLES SALOME EXAMPLES components
  23  */
  24
  25 #include "SALOME_Component.idl"
  26 #include "SALOME_Exception.idl"
  27
  28
  29 /*!  \ingroup EXAMPLES
  30
  31 This package contains the interface HELLO_ORB used
  32 for  %HELLO component as an example in %SALOME application.
  33 */
  34 module HELLO_ORB
  35 {
  36   /*! \brief Interface of the %HELLO component
  37    */
  38   interface HELLO_Gen : Engines::Component
  39   {
  40      /*!
  41          Set the Name and return the string concatenation of "hello, " and the given name.
  42       */
  43      string makeBanner(in string name)
  44          raises (SALOME::SALOME_Exception);
  45   };
  46 };
  47
  48 #endif
  49