OpenWalnut  1.4.0
WModuleSignals.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WMODULESIGNALS_H
26 #define WMODULESIGNALS_H
27 
28 #ifndef Q_MOC_RUN
29 #include <boost/signals2/signal.hpp>
30 #endif
31 #ifndef Q_MOC_RUN
32 #include <boost/function.hpp>
33 #endif
34 
35 class WModule;
36 class WException;
37 
38 /**
39  * Enum of all possible signals WModule instances can emit.
40  */
41 enum MODULE_SIGNAL
42 {
43  WM_ASSOCIATED, // module got associated to a container
44  WM_READY, // module ready
45  WM_ERROR, // error during execution
46  WM_REMOVED // removed from the container
47 };
48 
49 // **************************************************************************************************************************
50 // Types
51 // **************************************************************************************************************************
52 
53 /**
54  * Signal for generic events like "WM_READY".
55  *
56  * \param module The module emitting the signal.
57  *
58  */
59 typedef boost::function< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalHandlerType;
60 
61 /**
62  * Generic signal type used in the most signals involving just the emitting signal.
63  *
64  * \param module The module emitting the signal.
65  */
66 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalType;
67 
68 /**
69  * Signal for error events like "WM_ERROR".
70  *
71  * \param module The module emitting the signal.
72  *
73  */
74 typedef boost::function< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalHandlerType;
75 
76 /**
77  * Signal type used in the most signals involving exceptions.
78  *
79  * \param module The module emitting the signal.
80  */
81 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalType;
82 
83 #endif // WMODULESIGNALS_H
84 
Class representing a single module of OpenWalnut.
Definition: WModule.h:83
Basic exception handler.
Definition: WException.h:38