src/DSC/DSC_Basic/DSC_Callbacks.hxx

   1 //  Copyright (C) 2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //
  21 //
  22 //  File   : DSC_Callbacks.hxx
  23 //  Author : André RIBES (EDF)
  24 //  Module : KERNEL
  25
  26 #ifndef _DSC_CALLBACKS_HXX_
  27 #define _DSC_CALLBACKS_HXX_
  28
  29 #include <DSC_Basic.hxx>
  30
  31 #include <SALOMEconfig.h>
  32 #include CORBA_SERVER_HEADER(DSC_Engines)
  33
  34 /*! \class DSC_Callbacks
  35  *  \brief This is an abstract class that defines methods that the component
  36  *  uses to prevent the component user code that the state of the component has changed.
  37  *  Currently only port's connection modifications are signaled.
  38  */
  39 class DSC_BASIC_EXPORT DSC_Callbacks
  40 {
  41   public:
  42     DSC_Callbacks() {}
  43     virtual ~DSC_Callbacks() {}
  44
  45     /*!
  46      * This method is used by the component when the number of connection
  47      * on a provides port changes. This information helps the user code to detect
  48      * operation on its ports.
  49      *
  50      *
  51      * \param provides_port_name the name of the provides name that has changed.
  52      * \param connection_nbr the new number of connection on the provides port.
  53      * \param message contains informations about the modification of the port.
  54      */
  55     virtual void provides_port_changed(const char* provides_port_name,
  56                                        int connection_nbr,
  57                                        const Engines::DSC::Message message) = 0;
  58
  59     /*!
  60      * This method is used by the component when the number of connection
  61      * on a uses port changes. This information helps the user code to detect
  62      * operation on its ports.
  63      *
  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