]> Creatis software - bbtk.git/blob - packages/std/src/bbstdRelay.h
#3474 bug profile_creatools in Linux/Win32
[bbtk.git] / packages / std / src / bbstdRelay.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: bbstdRelay.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:51:32 $
33   Version:   $Revision: 1.11 $
34 =========================================================================*/
35
36 #ifndef __bbstdRelay_h_INCLUDED_H__
37 #define __bbstdRelay_h_INCLUDED_H__
38
39 #include "bbtkAtomicBlackBox.h"
40 #include "bbstd_EXPORT.h"
41
42 namespace bbstd
43 {
44   //=======================================================================
45   template <class T>
46   class bbstd_EXPORT Relay
47     :
48   public bbtk::AtomicBlackBox
49   {
50     BBTK_TEMPLATE_BLACK_BOX_INTERFACE(Relay,bbtk::AtomicBlackBox,T);
51     BBTK_DECLARE_INPUT(In,T);
52     BBTK_DECLARE_OUTPUT(Out,T);
53     BBTK_PROCESS(Process);
54   protected:
55     void Process() { bbSetOutputOut ( bbGetInputIn() ); }
56   };
57   //=======================================================================
58
59   //=======================================================================
60   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(Relay,bbtk::AtomicBlackBox);
61   BBTK_NAME(bbtk::HumanTypeName<T>()+"Relay");
62   BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
63   BBTK_CATEGORY("misc");
64   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.");
65   BBTK_TEMPLATE_INPUT(Relay,In,"Input",T);
66   BBTK_TEMPLATE_OUTPUT(Relay,Out,"Output",T);
67   BBTK_END_DESCRIBE_TEMPLATE_BLACK_BOX(Relay);
68   //=======================================================================
69
70   template <class T> void Relay<T>::bbUserSetDefaultValues() {}
71   template <class T> void Relay<T>::bbUserInitializeProcessing() {}
72   template <class T> void Relay<T>::bbUserFinalizeProcessing() {}
73
74 }
75 // namespace bbstd
76
77 //=======================================================================
78 // MACRO
79
80 #define BBTK_DEFINE_RELAY_BLACK_BOX(TYPE,PACKAGE,NAME)  \
81 class bb ## PACKAGE ## _EXPORT NAME : public bbtk::AtomicBlackBox { \
82   BBTK_BLACK_BOX_INTERFACE(NAME,bbtk::AtomicBlackBox); \
83   BBTK_DECLARE_INPUT(In,TYPE); \
84   BBTK_DECLARE_OUTPUT(Out,TYPE); \
85   BBTK_PROCESS(Process); \
86  protected: \
87   void Process() { bbSetOutputOut ( bbGetInputIn() ); } \
88 }; \
89 BBTK_BEGIN_DESCRIBE_BLACK_BOX(NAME,bbtk::AtomicBlackBox);\
90 BBTK_NAME(#NAME); \
91 BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr"); \
92 BBTK_CATEGORY("misc"); \
93 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."); \
94 BBTK_INPUT(NAME,In,"Input",TYPE,"");\
95 BBTK_OUTPUT(NAME,Out,"Output",TYPE,"");\
96 BBTK_END_DESCRIBE_BLACK_BOX(NAME);
97
98 //=======================================================================
99
100 #endif // __bbstdRelay_h_INCLUDED_H__