SST::EventHandler< ConsumerT, ReturnT, Param1T > Class Template Reference

Simple event handler functor. More...

#include <eventFunctor.h>

Inheritance diagram for SST::EventHandler< ConsumerT, ReturnT, Param1T >:

SST::EventHandlerBase< ReturnT, Param1T >

Public Member Functions

 EventHandler (ConsumerT *const object, PtrMember member)
 Constructor.
 EventHandler (const EventHandler< ConsumerT, ReturnT, Param1T > &e)
 Copy Constructor.
virtual ReturnT operator() (Param1T param1)
 Operator called when event is triggered by the simulator core.

Friends

class boost::serialization::access
template<class Archive>
void save_construct_data (Archive &ar, const EventHandler< ConsumerT, ReturnT, Param1T > *t, const unsigned int file_version)
template<class Archive>
void load_construct_data (Archive &ar, EventHandler< ConsumerT, ReturnT, Param1T > *t, const unsigned int file_version)

Data Structures

struct  member_t

Detailed Description

template<typename ConsumerT, typename ReturnT, typename Param1T>
class SST::EventHandler< ConsumerT, ReturnT, Param1T >

Simple event handler functor.

Creates an event handler which, when triggered, calls a member function of a target Component with the event as argument. I.e.

component->member_function(event);

Template Parameters:
ConsumerT Computer type which recieves the event
ReturnT return type of the event
Param1T Parameter which the event handler recieves

Constructor & Destructor Documentation

template<typename ConsumerT, typename ReturnT, typename Param1T>
SST::EventHandler< ConsumerT, ReturnT, Param1T >::EventHandler ( ConsumerT *const   object,
PtrMember  member 
) [inline]

Constructor.

Parameters:
object Object (usually a Component) upon which the member function is invoked
member member function to invoke


Member Function Documentation

template<typename ConsumerT, typename ReturnT, typename Param1T>
virtual ReturnT SST::EventHandler< ConsumerT, ReturnT, Param1T >::operator() ( Param1T  param1  )  [inline, virtual]

Operator called when event is triggered by the simulator core.

Calls the Component's member function with the event as argument

Implements SST::EventHandlerBase< ReturnT, Param1T >.


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

Generated on Sat Jun 19 02:59:43 2010 for SST by  doxygen 1.5.6