kernel/src/bbtkBlackBoxOutputConnector.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkBlackBoxOutputConnector.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/06/08 14:50:03 $
   6   Version:   $Revision: 1.10 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32 /**
  33  *  \file
  34  *  \brief Class bbtk::BlackBoxOutputConnector :
  35  */
  36 /**
  37  * \class bbtk::BlackBoxOutputConnector
  38  * \brief
  39  */
  40
  41 #ifndef __bbtkBlackBoxOutputConnector_h__
  42 #define __bbtkBlackBoxOutputConnector_h__
  43
  44 #include "bbtkPimpl.h"
  45 #include "bbtkConnection.h"
  46 #include "bbtkBlackBox.h"
  47 #include "bbtkMessageManager.h"
  48 #include <vector>
  49
  50
  51 namespace bbtk
  52 {
  53
  54
  55   class BBTK_EXPORT BlackBoxOutputConnector
  56   {
  57   public:
  58
  59
  60     typedef BlackBox::OutputChangeCallbackType OutputChangeCallbackType;
  61
  62     /// Ctor
  63     BlackBoxOutputConnector(BlackBoxPointer b);
  64     /// Dtor
  65     ~BlackBoxOutputConnector();
  66
  67     /// Sets a connection
  68     void SetConnection(Connection* c);
  69     /// Unsets the connection
  70     void UnsetConnection(Connection* c);
  71     /// The type of vector of output connections
  72     typedef std::vector<Connection*> ConnectionVector;
  73     /// Returns the vector of connection plugged into this output (const)
  74     const ConnectionVector& GetConnectionVector() const;
  75
  76     /// Returns the status of the input
  77     IOStatus GetStatus() const;
  78     /// Sets the status of the input
  79     void SetStatus( IOStatus s );
  80
  81     /// Signals the change observers that the output has changed
  82     void SignalChange( BlackBox::Pointer box, const std::string& output );
  83
  84
  85     /// Adds the function f to the list of functions to call when
  86     /// the output changes.
  87     void AddChangeObserver(OutputChangeCallbackType f);
  88
  89     /// Removes the function f from the list of functions to call when
  90     /// the output changes (TO WRITE)
  91     void RemoveChangeObserver(OutputChangeCallbackType f);
  92
  93       /// Private implementation
  94     BBTK_DECLARE_PIMPL(BlackBoxOutputConnector);
  95
  96   private:
  97     /// Purposedly not implemented
  98     BlackBoxOutputConnector(const BlackBoxOutputConnector&);
  99
 100   };
 101
 102 }
 103 // namespace bbtk
 104 #endif