]> Creatis software - bbtk.git/blob - kernel/src/bbtkBlackBoxInputConnector.h
no message
[bbtk.git] / kernel / src / bbtkBlackBoxInputConnector.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbtkBlackBoxInputConnector.h,v $
4   Language:  C++
5   Date:      $Date: 2009/06/08 14:50:03 $
6   Version:   $Revision: 1.8 $
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 "bbtkPimpl.h"
46 #include <vector>
47
48 namespace bbtk
49 {
50
51   class BlackBox;
52   BBTK_FORWARD_DECLARE_POINTER(BlackBox);
53
54   class BBTK_EXPORT BlackBoxInputConnector 
55   {
56   public:
57      
58     /// Ctor
59     BlackBoxInputConnector(BlackBoxPointer b);
60     /// Dtor
61     ~BlackBoxInputConnector();    
62
63     /// Sets a connection
64     void SetConnection(Connection* c);
65     /// Unsets the connection 
66     /// The parameter is USELESS today but would be useful if we allow multiple connections on inputs
67     void UnsetConnection(Connection* c);
68     /// Returns the connection plugged into this input (const)
69     Connection* GetConnection() const;
70     /// Returns true iff a connection is connected to it
71     bool IsConnected() const;
72     
73
74     // Recursive execution
75     void RecursiveExecute();
76
77
78     /// Returns the status of the input 
79     IOStatus GetStatus() const;
80     /// Sets the status of the input 
81     void SetStatus(IOStatus s);
82     
83     /// Returns the black box which owns the connector
84     BlackBoxPointer GetBlackBox() const;
85
86
87     /// Private implementation
88     BBTK_DECLARE_PIMPL(BlackBoxInputConnector);
89  
90   private:
91     /// Purposedly not implemented
92     BlackBoxInputConnector(const BlackBoxInputConnector&);
93   };
94   
95 }
96 // namespace bbtk
97 #endif