src/DSC/DSC_User/uses_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   : uses_port.hxx
  23 //  Author : André RIBES (EDF)
  24 //  Module : KERNEL
  25 //
  26 #ifndef _USES_PORT_HXX_
  27 #define _USES_PORT_HXX_
  28
  29 #include "base_port.hxx"
  30 #include "SALOME_Ports.hh"
  31 #include "DSC_Engines.hh"
  32
  33 /*! \class uses_port
  34  *  \brief This class implements a DSC_User uses C++ port.
  35  *
  36  *  This class is base class for all DSC_User uses port.
  37  *  It's an abstract class.
  38  *
  39  *  Contrary to DSC_Basic layer, a uses port as an implementation
  40  *  provided by this class which permits to manipulate the uses port.
  41  */
  42 class uses_port : public base_port
  43 {
  44   public :
  45     uses_port();
  46     virtual ~uses_port();
  47
  48     /*!
  49      * This is used by the component to get the CORBA repository id
  50      * of the uses port. It's an abstract method.
  51      *
  52      * \return port's CORBA repository id.
  53      */
  54     virtual const char * get_repository_id() = 0;
  55
  56     /*!
  57      * This method is the uses port's callback to be aware of
  58      * connections states.
  59      * It's an abstract method. The uses port uses this method
  60      * to manage the sequence of the DSC_Basic uses port.
  61      *
  62      * \param new_uses_port new uses port sequence.
  63      * \param message message associated with this modification.
  64      */
  65     virtual void uses_port_changed(Engines::DSC::uses_port * new_uses_port,
  66                                    const Engines::DSC::Message message) = 0;
  67
  68 };
  69
  70 #endif
  71