src/DSC/DSC_User/provides_port.hxx

   1 // Copyright (C) 2007-2023  CEA, EDF, 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, or (at your option) any later version.
  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
  23 //  File   : provides_port.hxx
  24 //  Author : André RIBES (EDF)
  25 //  Module : KERNEL
  26 //
  27 #ifndef _PROVIDES_PORT_HXX_
  28 #define _PROVIDES_PORT_HXX_
  29
  30 #include "base_port.hxx"
  31 #include "SALOME_Ports.hh"
  32 #include "DSC_Engines.hh"
  33
  34 /*! \class provides_port
  35  *  \brief This class implements a DSC_User provides C++ port.
  36  *
  37  *  This class is base class for all DSC_User provides port.
  38  *  It's an abstract class.
  39  */
  40 class provides_port : public base_port
  41 {
  42   public :
  43     provides_port();
  44     virtual ~provides_port();
  45
  46     /*!
  47      * This method permits to get the CORBA reference of the port.
  48      *
  49      * \return port's CORBA reference.
  50      */
  51     virtual Ports::Port_ptr get_port_ref() = 0;
  52
  53     /*!
  54      * This method is the callback called by the component to inform
  55      * the provides port of a new or a removed connection.
  56      *
  57      * \param connection_nbr current connection number.
  58      * \param message message associated with this connection.
  59      */
  60     virtual void provides_port_changed(int /*connection_nbr*/,
  61                                        const Engines::DSC::Message /*message*/) {}
  62
  63 };
  64
  65 #endif
  66