src/DSC/DSC_User/Basic/data_short_port_uses.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   : data_short_port_uses.hxx
  24 //  Author : André RIBES (EDF)
  25 //  Module : KERNEL
  26 //
  27 #ifndef _DATA_SHORT_PORT_USES_HXX_
  28 #define _DATA_SHORT_PORT_USES_HXX_
  29
  30 #include "uses_port.hxx"
  31 #include "SALOME_Ports.hh"
  32
  33 /*! \class data_short_port_uses
  34  *  \brief This class a port that sends a CORBA short with
  35  *  the basic port policy.
  36  */
  37 class data_short_port_uses :
  38   public virtual uses_port
  39 {
  40   public :
  41     data_short_port_uses();
  42     virtual ~data_short_port_uses();
  43
  44     /*!
  45      * This method is used by the component to get
  46      * port's CORBA repository id
  47      *
  48      * \return port's CORBA repository id
  49      */
  50     virtual const char * get_repository_id();
  51
  52     /*!
  53      * This method is used by the component to send
  54      * a short value to all the provides ports connected.
  55      *
  56      * \param data the short sended.
  57      */
  58     virtual void put(CORBA::Short data);
  59
  60     /*!
  61      * This method is a callback for be aware of modification
  62      * of the port's connections.
  63      *
  64      * \param new_uses_port the new uses port's sequence.
  65      * \param message message associated to the modification.
  66      */
  67     virtual void uses_port_changed(Engines::DSC::uses_port * new_uses_port,
  68                                    const Engines::DSC::Message /*message*/);
  69
  70   private :
  71     Engines::DSC::uses_port * _my_ports;
  72 };
  73
  74 #endif
  75