1 /*=========================================================================
3 Module: $RCSfile: bbstdRelay.h,v $
5 Date: $Date: 2009/05/14 14:43:38 $
6 Version: $Revision: 1.10 $
7 =========================================================================*/
9 /* ---------------------------------------------------------------------
11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
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.
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
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 * ------------------------------------------------------------------------ */
32 #ifndef __bbstdRelay_h_INCLUDED_H__
33 #define __bbstdRelay_h_INCLUDED_H__
35 #include "bbtkAtomicBlackBox.h"
36 #include "bbstd_EXPORT.h"
40 //=======================================================================
42 class bbstd_EXPORT Relay
44 public bbtk::AtomicBlackBox
46 BBTK_TEMPLATE_BLACK_BOX_INTERFACE(Relay,bbtk::AtomicBlackBox,T);
47 BBTK_DECLARE_INPUT(In,T);
48 BBTK_DECLARE_OUTPUT(Out,T);
49 BBTK_PROCESS(Process);
51 void Process() { bbSetOutputOut ( bbGetInputIn() ); }
53 //=======================================================================
55 //=======================================================================
56 BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(Relay,bbtk::AtomicBlackBox);
57 BBTK_NAME(bbtk::HumanTypeName<T>()+"Relay");
58 BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
59 BBTK_CATEGORY("misc");
60 BBTK_DESCRIPTION("Just copies the value of its input to its output. Usefull to plug an input of a complex box into different internal boxes.");
61 BBTK_TEMPLATE_INPUT(Relay,In,"Input",T);
62 BBTK_TEMPLATE_OUTPUT(Relay,Out,"Output",T);
63 BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(Relay);
64 //=======================================================================
66 template <class T> void Relay<T>::bbUserSetDefaultValues() {}
67 template <class T> void Relay<T>::bbUserInitializeProcessing() {}
68 template <class T> void Relay<T>::bbUserFinalizeProcessing() {}
73 //=======================================================================
76 #define BBTK_DEFINE_RELAY_BLACK_BOX(TYPE,PACKAGE,NAME) \
77 class bb ## PACKAGE ## _EXPORT NAME : public bbtk::AtomicBlackBox { \
78 BBTK_BLACK_BOX_INTERFACE(NAME,bbtk::AtomicBlackBox); \
79 BBTK_DECLARE_INPUT(In,TYPE); \
80 BBTK_DECLARE_OUTPUT(Out,TYPE); \
81 BBTK_PROCESS(Process); \
83 void Process() { bbSetOutputOut ( bbGetInputIn() ); } \
85 BBTK_BEGIN_DESCRIBE_BLACK_BOX(NAME,bbtk::AtomicBlackBox);\
87 BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr"); \
88 BBTK_CATEGORY("misc"); \
89 BBTK_DESCRIPTION("Just copies the value of its input to its output. Usefull to plug an input of a complex box into different internal boxes."); \
90 BBTK_INPUT(NAME,In,"Input",TYPE,"");\
91 BBTK_OUTPUT(NAME,Out,"Output",TYPE,"");\
92 BBTK_END_DESCRIBE_BLACK_BOX(NAME);
94 //=======================================================================
96 #endif // __bbstdRelay_h_INCLUDED_H__