fix doc example typo
[boost.git] / boost / statechart / deferral.hpp
blob8bb6f7259d49c766218912fe5f72690ff8a68350
1 #ifndef BOOST_STATECHART_DEFERRAL_HPP_INCLUDED
2 #define BOOST_STATECHART_DEFERRAL_HPP_INCLUDED
3 //////////////////////////////////////////////////////////////////////////////
4 // Copyright 2002-2006 Andreas Huber Doenni
5 // Distributed under the Boost Software License, Version 1.0. (See accompany-
6 // ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
7 //////////////////////////////////////////////////////////////////////////////
11 #include <boost/statechart/result.hpp>
15 namespace boost
17 namespace statechart
22 class event_base;
24 //////////////////////////////////////////////////////////////////////////////
25 template< class Event >
26 class deferral
28 public:
29 //////////////////////////////////////////////////////////////////////////
30 // The following declarations should be private.
31 // They are only public because many compilers lack template friends.
32 //////////////////////////////////////////////////////////////////////////
33 template< class State, class EventBase, class IdType >
34 static detail::reaction_result react(
35 State & stt, const EventBase &, const IdType & eventType )
37 if ( eventType == Event::static_type() )
39 return detail::result_utility::get_result( stt.defer_event() );
41 else
43 return detail::no_reaction;
48 template<>
49 class deferral< event_base >
51 public:
52 //////////////////////////////////////////////////////////////////////////
53 // The following declarations should be private.
54 // They are only public because many compilers lack template friends.
55 //////////////////////////////////////////////////////////////////////////
56 template< class State, class EventBase, class IdType >
57 static detail::reaction_result react(
58 State & stt, const EventBase &, const IdType & )
60 return detail::result_utility::get_result( stt.defer_event() );
66 } // namespace statechart
67 } // namespace boost
71 #endif