src/DSC/DSC_User/provides_port.hxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  File   : provides_port.hxx
  23 //  Author : André RIBES (EDF)
  24 //  Module : KERNEL
  25 //
  26 #ifndef _PROVIDES_PORT_HXX_
  27 #define _PROVIDES_PORT_HXX_
  28
  29 #include "base_port.hxx"
  30 #include "SALOME_Ports.hh"
  31 #include "DSC_Engines.hh"
  32
  33 /*! \class provides_port
  34  *  \brief This class implements a DSC_User provides C++ port.
  35  *
  36  *  This class is base class for all DSC_User provides port.
  37  *  It's an abstract class.
  38  */
  39 class provides_port : public base_port
  40 {
  41   public :
  42     provides_port();
  43     virtual ~provides_port();
  44
  45     /*!
  46      * This method permits to get the CORBA reference of the port.
  47      *
  48      * \return port's CORBA reference.
  49      */
  50     virtual Ports::Port_ptr get_port_ref() = 0;
  51
  52     /*!
  53      * This method is the callback called by the component to inform
  54      * the provides port of a new or a removed connection.
  55      *
  56      * \param connection_nbr current connection number.
  57      * \param message message associated with this connection.
  58      */
  59     virtual void provides_port_changed(int connection_nbr,
  60                                        const Engines::DSC::Message message) {}
  61
  62 };
  63
  64 #endif
  65