This class defines an event created by an event source. More...

#include <RTEvent.h>

Inheritance diagram for fesa::RTEvent:

Public Member Functions
	RTEvent (AbstractEventSource *eventSource, const boost::shared_ptr< Diagnostics > &diagnostics)
	Constructor. More...

	RTEvent ()
	Empty-Constructor for unit-testing (Mocking of this Class)

virtual boost::shared_ptr < const RTEventPayload >	getPayload () const
	Retrieves the payload attached to the event. More...

virtual void	setPayload (const boost::shared_ptr< RTEventPayload > &payload)
	Sets the payload of the RTEvent to the passed value. More...

virtual void	setName (const std::string &concreteEventName)
	Sets the name of this RTEvent to the passed value. More...

virtual const std::string &	getName () const
	Returns the name of this RTEvent. More...

virtual AbstractEventSource *	getEventSource ()
	Retrieves the event source that produced the event. More...

Public Member Functions inherited from fesa::AbstractEvent
virtual	~AbstractEvent ()
	Destructor.

MultiplexingContext *	getMultiplexingContext () const
	Returns a pointer to the context attached to the event. More...

boost::shared_ptr < MultiplexingContext >	getMultiplexingContextSharedPointer () const
	Returns a shared-pointer to the context attached to the event. More...

void	setMultiplexingContext (boost::shared_ptr< MultiplexingContext > &multiplexingContext)
	Set's the multiplexing-context of this RT-event to the passed multiplexingContext. More...

Additional Inherited Members
Protected Attributes inherited from fesa::AbstractEvent
boost::shared_ptr < MultiplexingContext >	multiplexingContext_
	Multiplexing context attached to the event.

Detailed Description

This class defines an event created by an event source.

Constructor & Destructor Documentation

fesa::RTEvent::RTEvent	(	AbstractEventSource *	eventSource,
		const boost::shared_ptr< Diagnostics > &	diagnostics
	)

Constructor.

Parameters

eventSource	pointer to the event-source which fires the event
diagnostics	diagnostic-logger, used to trace the event

AbstractEventSource * fesa::RTEvent::getEventSource ( )

virtual

Retrieves the event source that produced the event.

const std::string & fesa::RTEvent::getName ( ) const

virtual

Returns the name of this RTEvent.

boost::shared_ptr< const RTEventPayload > fesa::RTEvent::getPayload ( ) const

inlinevirtual

Retrieves the payload attached to the event.

Exceptions

FesaException if there is no payload

void fesa::RTEvent::setName ( const std::string & concreteEventName )

virtual

Sets the name of this RTEvent to the passed value.

Parameters

new	name of this RTEvent

void fesa::RTEvent::setPayload ( const boost::shared_ptr< RTEventPayload > & payload )

virtual

Sets the payload of the RTEvent to the passed value.

Parameters

shared-pointer to the payload to set

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