src/DSC/DSC_Basic/DSC_Callbacks.hxx

   1 // Copyright (C) 2007-2023  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, 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   : DSC_Callbacks.hxx
  24 //  Author : André RIBES (EDF)
  25 //  Module : KERNEL
  26 //
  27 #ifndef _DSC_CALLBACKS_HXX_
  28 #define _DSC_CALLBACKS_HXX_
  29
  30 #include "DSC_Basic.hxx"
  31
  32 #include <SALOMEconfig.h>
  33 #include CORBA_SERVER_HEADER(DSC_Engines)
  34
  35 /*! \class DSC_Callbacks
  36  *  \brief This is an abstract class that defines methods that the component
  37  *  uses to notify the component user code that the state of the component has changed.
  38  *
  39  *  Currently only port's connection modifications are signaled.
  40  */
  41 class DSC_BASIC_EXPORT DSC_Callbacks
  42 {
  43   public:
  44     DSC_Callbacks() {}
  45     virtual ~DSC_Callbacks() {}
  46
  47     /*! \brief This method is used by the component when the number of connection
  48      * on a provides port changes.
  49      *
  50      * This information helps the user code to detect operation on its ports.
  51      *
  52      * \param provides_port_name the name of the provides name that has changed.
  53      * \param connection_nbr the new number of connection on the provides port.
  54      * \param message contains informations about the modification of the port.
  55      */
  56     virtual void provides_port_changed(const char* provides_port_name,
  57                                        int connection_nbr,
  58                                        const Engines::DSC::Message message) = 0;
  59
  60     /*! \brief  This method is used by the component when the number of connection
  61      * on a uses port changes.
  62      *
  63      * This information helps the user code to detect operation on its ports.
  64      *
  65      * \param uses_port_name the name of the uses name that has changed.
  66      * \param new_uses_port the new sequence representing the uses port.
  67      * \param message contains informations about the modification of the port.
  68      */
  69     virtual void uses_port_changed(const char* uses_port_name,
  70                                    Engines::DSC::uses_port * new_uses_port,
  71                                    const Engines::DSC::Message message) = 0;
  72 };
  73
  74 #endif