kernel/src/bbtkBlackBoxInputConnector.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkBlackBoxInputConnector.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/12/11 09:50:35 $
   6   Version:   $Revision: 1.7 $
   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::BlackBoxInputConnector :
  35  */
  36 /**
  37  * \class bbtk::BlackBoxInputConnector
  38  * \brief
  39  */
  40
  41 #ifndef __bbtkBlackBoxInputConnector_h__
  42 #define __bbtkBlackBoxInputConnector_h__
  43
  44 #include "bbtkConnection.h"
  45 #include <vector>
  46
  47 namespace bbtk
  48 {
  49
  50   class BlackBox;
  51   BBTK_FORWARD_DECLARE_POINTER(BlackBox);
  52
  53   class BBTK_EXPORT BlackBoxInputConnector
  54   {
  55   public:
  56
  57     /// Ctor
  58     BlackBoxInputConnector(BlackBoxPointer b);
  59     /// Dtor
  60     ~BlackBoxInputConnector();
  61     /// Sets a connection
  62     void SetConnection(Connection* c);
  63     /// Unsets the connection
  64     /// The parameter is USELESS today but would be useful if we allow multiple connections on inputs
  65     void UnsetConnection(Connection* c);
  66
  67     // Recursive execution
  68     void RecursiveExecute();
  69
  70     /// Returns the connection plugged into this input (const)
  71     Connection* GetConnection() const { return mConnection; }
  72     /// Returns true iff a connection is connected to it
  73     bool IsConnected() const { return (mConnection != 0); }
  74
  75
  76     /// Returns the status of the input
  77     IOStatus GetStatus() const { return mStatus; }
  78     /// Sets the status of the input
  79     void SetStatus(IOStatus s) { mStatus = s; }
  80
  81
  82
  83     /// Returns the black box which owns the connector
  84     BlackBoxPointer GetBlackBox() const { return mBox.lock(); }
  85   private:
  86     ///
  87     BlackBoxWeakPointer mBox;
  88     /// The connection plugged into the input
  89     Connection* mConnection;
  90     /// The status of the input (UPTODATE | MODIFIED | OUTOFDATE)
  91     IOStatus mStatus;
  92
  93   };
  94
  95 }
  96 // namespace bbtk
  97 #endif