sttcl  v0.9c
STTCL C++ template state machine framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes
sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs > Struct Template Reference

#include <Region.h>

Collaboration diagram for sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef RegionBase
< RegionContainerImpl,
IInnerState, EventArgs > 		RegionBaseClass
typedef
EventArgsInterfaceSelector
< RegionContainerImpl,
IInnerState, EventArgs > 		EventArgsSelectorType
typedef
EventArgsSelectorType::RefCountPtr 		RefCountPtr
typedef
EventArgsSelectorType::InnerEventHandler 		InnerEventHandler
typedef void(RegionBaseClass::* InternalEventHandler )(bool)

Public Member Functions

 DispatchedEvent (RegionContainerImpl *argContext, IInnerState *argState, InnerEventHandler argHandler, RefCountPtr argEventArgs)
 DispatchedEvent (InternalEventHandler argInternalHandler, bool argRecursiveInternalEvent)
 DispatchedEvent (const DispatchedEvent &rhs)
DispatchedEvent & operator= (const DispatchedEvent &rhs)

Public Attributes

RegionContainerImpl * context
IInnerState * state
InnerEventHandler handler
RefCountPtr eventArgs
InternalEventHandler internalHandler
bool recursiveInternalEvent

Detailed Description

template<class RegionContainerImpl, class IInnerState, class EventArgs>
struct sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >

Container struct to dispatch events to the inner region thread.

Member Typedef Documentation

template<class RegionContainerImpl, class IInnerState, class EventArgs>
typedef EventArgsInterfaceSelector<RegionContainerImpl,IInnerState,EventArgs> sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::EventArgsSelectorType
template<class RegionContainerImpl, class IInnerState, class EventArgs>
typedef EventArgsSelectorType::InnerEventHandler sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::InnerEventHandler

The inner event handler signature.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
typedef void(RegionBaseClass::* sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::InternalEventHandler)(bool)

The internal event handler signature.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
typedef EventArgsSelectorType::RefCountPtr sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::RefCountPtr

The pointer type used to pass event arguments to the contained regions inner states.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
typedef RegionBase<RegionContainerImpl,IInnerState,EventArgs> sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::RegionBaseClass

The RegionBase class type.

Constructor & Destructor Documentation

template<class RegionContainerImpl, class IInnerState, class EventArgs>
sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::DispatchedEvent ( RegionContainerImpl *  argContext,
IInnerState *  argState,
InnerEventHandler  argHandler,
RefCountPtr  argEventArgs 
)
inline

Constructor for struct DispatchedEvent, constructs an inner state event.

Parameters:
argContext
argState
argHandler
argEventArgs
template<class RegionContainerImpl, class IInnerState, class EventArgs>
sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::DispatchedEvent ( InternalEventHandler  argInternalHandler,
bool  argRecursiveInternalEvent 
)
inline

Constructor for struct DispatchedEvent, constructs an internal event.

Parameters:
argInternalHandler
argRecursiveInternalEvent
template<class RegionContainerImpl, class IInnerState, class EventArgs>
sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::DispatchedEvent ( const DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs > &  rhs)
inline

Copy constructor for struct DispatchedEvent.

Parameters:
rhs

Member Function Documentation

template<class RegionContainerImpl, class IInnerState, class EventArgs>
DispatchedEvent& sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::operator= ( const DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs > &  rhs)
inline

Copy constructor for struct DispatchedEvent.

Parameters:
rhs

Member Data Documentation

template<class RegionContainerImpl, class IInnerState, class EventArgs>
RegionContainerImpl* sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::context

The context state machine where the event was issued.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
RefCountPtr sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::eventArgs
mutable

The event arguments pointer to pass to the dispatched inner event handler method.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
InnerEventHandler sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::handler

The dispatched inner event handler method.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
InternalEventHandler sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::internalHandler

The dispatched internal event handler method.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
bool sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::recursiveInternalEvent

The flag passed to the dispatched internal event handler method.

template<class RegionContainerImpl, class IInnerState, class EventArgs>
IInnerState* sttcl::internal::DispatchedEvent< RegionContainerImpl, IInnerState, EventArgs >::state

The inner region state for calling the dispatched event handler.

The documentation for this struct was generated from the following file: