kernel/src/bbtkBlackBoxInputConnector.h

   1 /*
   2  # ---------------------------------------------------------------------
   3  #
   4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5  #                        pour la SantÈ)
   6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9  #
  10  #  This software is governed by the CeCILL-B license under French law and
  11  #  abiding by the rules of distribution of free software. You can  use,
  12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13  #  license as circulated by CEA, CNRS and INRIA at the following URL
  14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15  #  or in the file LICENSE.txt.
  16  #
  17  #  As a counterpart to the access to the source code and  rights to copy,
  18  #  modify and redistribute granted by the license, users are provided only
  19  #  with a limited warranty  and the software's author,  the holder of the
  20  #  economic rights,  and the successive licensors  have only  limited
  21  #  liability.
  22  #
  23  #  The fact that you are presently reading this means that you have had
  24  #  knowledge of the CeCILL-B license and that you accept its terms.
  25  # ------------------------------------------------------------------------ */
  26
  27
  28 /*=========================================================================
  29   Program:   bbtk
  30   Module:    $RCSfile: bbtkBlackBoxInputConnector.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:49:01 $
  33   Version:   $Revision: 1.9 $
  34 =========================================================================*/
  35
  36
  37 /**
  38  *  \file
  39  *  \brief Class bbtk::BlackBoxInputConnector :
  40  */
  41 /**
  42  * \class bbtk::BlackBoxInputConnector
  43  * \brief
  44  */
  45
  46 #ifndef __bbtkBlackBoxInputConnector_h__
  47 #define __bbtkBlackBoxInputConnector_h__
  48
  49 #include "bbtkConnection.h"
  50 #include "bbtkPimpl.h"
  51 #include <vector>
  52
  53 namespace bbtk
  54 {
  55
  56   class BlackBox;
  57   BBTK_FORWARD_DECLARE_POINTER(BlackBox);
  58
  59   class BBTK_EXPORT BlackBoxInputConnector
  60   {
  61   public:
  62
  63     /// Ctor
  64     BlackBoxInputConnector(BlackBoxPointer b);
  65     /// Dtor
  66     ~BlackBoxInputConnector();
  67
  68     /// Sets a connection
  69     void SetConnection(Connection* c);
  70     /// Unsets the connection
  71     /// The parameter is USELESS today but would be useful if we allow multiple connections on inputs
  72     void UnsetConnection(Connection* c);
  73     /// Returns the connection plugged into this input (const)
  74     Connection* GetConnection() const;
  75     /// Returns true iff a connection is connected to it
  76     bool IsConnected() const;
  77
  78
  79     // Recursive execution
  80     void RecursiveExecute();
  81
  82
  83     /// Returns the status of the input
  84     IOStatus GetStatus() const;
  85     /// Sets the status of the input
  86     void SetStatus(IOStatus s);
  87
  88     /// Returns the black box which owns the connector
  89     BlackBoxPointer GetBlackBox() const;
  90
  91
  92     /// Private implementation
  93     BBTK_DECLARE_PIMPL(BlackBoxInputConnector);
  94
  95   private:
  96     /// Purposedly not implemented
  97     BlackBoxInputConnector(const BlackBoxInputConnector&);
  98   };
  99
 100 }
 101 // namespace bbtk
 102 #endif