Reference

EventRouter::EventMapper Class Reference

#include <EventRouter.h>

Detailed Description

Does the actual storage of the mapping between EventBase's and the EventListeners/EventTrappers who should receive them.

Actually only stores void*'s, so it's more general than just Listeners or Trappers

Definition at line 408 of file EventRouter.h.

Public Member Functions

EventMapper ()

constructor

void addMapping (void *el, EventBase::EventGeneratorID_t egid)

Adds a listener for all events from a given event generator.

void addMapping (void *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)

Adds a listener for a specific source id and type from a given event generator.

bool removeMapping (void *el, EventBase::EventGeneratorID_t egid)

Removes a listener for all events from a given event generator, returns true if something was actually removed.

bool removeMapping (void *el, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid)

Removes a listener for a specific source id and type from a given event generator, returns true if something was actually removed.

void clean ()

removes empty data structures for all event generators

void clean (EventBase::EventGeneratorID_t egid)

removes empty data structures associated with a single event generator

void clear ()

Resets the mapping.

template<class T>

void getMapping (const EventBase &e, std::vector< T * > &listeners) const

builds a list of all listeners which should receive the event, templated to typecast the pointers for you

bool verifyMapping (void *listener, const EventBase &e) const

Used to make sure that the specified listener exists for the given event.

bool verifyMapping (void *listener, EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid) const

Used to make sure that the specified listener exists for the given event.

bool verifyMappingAll (void *listener, EventBase::EventGeneratorID_t egid) const

Needed to complete EventRouter::isListening suite.

bool verifyMappingAny (void *listener, EventBase::EventGeneratorID_t egid) const

Needed to complete EventRouter::isListening suite.

bool verifyMappingAll (void *listener, EventBase::EventGeneratorID_t egid, unsigned int sid) const

Needed to complete EventRouter::isListening suite.

bool verifyMappingAny (void *listener, EventBase::EventGeneratorID_t egid, unsigned int sid) const

Needed to complete EventRouter::isListening suite.

bool hasMapping (EventBase::EventGeneratorID_t egid) const

so stuff can tell if it even needs to bother generating an event...

bool hasMapping (EventBase::EventGeneratorID_t egid, unsigned int sid) const

so stuff can tell if it even needs to bother generating an event...

bool hasMapping (EventBase::EventGeneratorID_t egid, unsigned int sid, EventBase::EventTypeID_t etid) const

so stuff can tell if it even needs to bother generating an event...

Protected Types

typedef std::map< unsigned
int, std::vector< void * >,
std::less< unsigned int > > SIDtoListenerVectorMap_t

a mapping from source IDs (unsigned ints), each to a vector of pointers to listeners

Protected Attributes

std::vector< void * > allevents [EventBase::numEGIDs]

an array of vectors of pointers to listeners... in other words, a vector of listener pointers for each generator

SIDtoListenerVectorMap_t * filteredevents [EventBase::numEGIDs][EventBase::numETIDs]

not for the faint of heart: a matrix of mappings to vectors of pointers to listeners

Private Member Functions

EventMapper (const EventMapper &)

this shouldn't be called...

EventMapper & operator= (const EventMapper &)

this shouldn't be called...

Member Typedef Documentation

typedef std::map<unsigned int,std::vector<void*>,std::less<unsigned int> > EventRouter::EventMapper::SIDtoListenerVectorMap_t [protected]

a mapping from source IDs (unsigned ints), each to a vector of pointers to listeners

main use in filteredevents

See also:: filteredevents

Definition at line 476 of file EventRouter.h.

Member Function Documentation

template<class T>

void EventRouter::EventMapper::getMapping	(	const EventBase &	e,
		std::vector< T * > &	listeners
	)			const

builds a list of all listeners which should receive the event, templated to typecast the pointers for you

Parameters:

	e	the key event
	listeners	upon return, the resulting list of listeners e maps to listeners is not cleared prior to building, new listeners are pushed on end Results are in the order: all specific matches first, all generator listeners second, in order they were added to the EventMapper.

Definition at line 730 of file EventRouter.cc.

Referenced by EventRouter::PostingStatus::PostingStatus().

bool EventRouter::EventMapper::hasMapping	(	EventBase::EventGeneratorID_t	egid,
		unsigned int	sid,
		EventBase::EventTypeID_t	etid
	)			const

so stuff can tell if it even needs to bother generating an event...

... if a tree falls in a forest, and there's no one around to see it, does it make a sound?
... if Vision sees a ball in an image, and there's no listeners, does it make an event? ;)

Returns:: true if it has any listeners, false otherwise

Definition at line 717 of file EventRouter.cc.

bool EventRouter::EventMapper::hasMapping	(	EventBase::EventGeneratorID_t	egid,
		unsigned int	sid
	)			const

so stuff can tell if it even needs to bother generating an event...

... if a tree falls in a forest, and there's no one around to see it, does it make a sound?
... if Vision sees a ball in an image, and there's no listeners, does it make an event? ;)

Returns:: true if it has any listeners, false otherwise

Definition at line 703 of file EventRouter.cc.

bool EventRouter::EventMapper::hasMapping ( EventBase::EventGeneratorID_t egid ) const

so stuff can tell if it even needs to bother generating an event...

... if a tree falls in a forest, and there's no one around to see it, does it make a sound?
... if Vision sees a ball in an image, and there's no listeners, does it make an event? ;)

Returns:: true if it has any listeners, false otherwise

Definition at line 688 of file EventRouter.cc.

Referenced by EventRouter::hasListeners().

bool EventRouter::EventMapper::removeMapping	(	void *	el,
		EventBase::EventGeneratorID_t	egid,
		unsigned int	sid,
		EventBase::EventTypeID_t	etid
	)

Removes a listener for a specific source id and type from a given event generator, returns true if something was actually removed.

Doesn't necessarily remove the vector or mapping if this was the last listener, use clean() to do that

Definition at line 623 of file EventRouter.cc.

bool EventRouter::EventMapper::removeMapping	(	void *	el,
		EventBase::EventGeneratorID_t	egid
	)

Removes a listener for all events from a given event generator, returns true if something was actually removed.

Doesn't necessarily remove the vector or mapping if this was the last listener, use clean() to do that

Definition at line 599 of file EventRouter.cc.

Referenced by EventRouter::removeListener(), and EventRouter::removeTrapper().

bool EventRouter::EventMapper::verifyMapping	(	void *	listener,
		EventBase::EventGeneratorID_t	egid,
		unsigned int	sid,
		EventBase::EventTypeID_t	etid
	)			const

Used to make sure that the specified listener exists for the given event.

This is needed because after we call processEvent on a lister, we can't assume that no other listeners have been modified - one listener could cause another to turn off. If that has happened, we shouldn't send the event, even if it was in the queue originally.

Definition at line 748 of file EventRouter.cc.

bool EventRouter::EventMapper::verifyMapping	(	void *	listener,
		const EventBase &	e
	)			const `[inline]`

Used to make sure that the specified listener exists for the given event.

Definition at line 451 of file EventRouter.h.

Referenced by EventRouter::isListening(), EventRouter::isTrapping(), and EventRouter::PostingStatus::process().

bool EventRouter::EventMapper::verifyMappingAll	(	void *	listener,
		EventBase::EventGeneratorID_t	egid,
		unsigned int	sid
	)			const

Needed to complete EventRouter::isListening suite.

Checks both allevents and filteredevents, must be found in all

Definition at line 805 of file EventRouter.cc.

bool EventRouter::EventMapper::verifyMappingAll	(	void *	listener,
		EventBase::EventGeneratorID_t	egid
	)			const

Needed to complete EventRouter::isListening suite.

Only checks allevents

Definition at line 771 of file EventRouter.cc.

Referenced by EventRouter::isListeningAll(), and EventRouter::isTrappingAll().

bool EventRouter::EventMapper::verifyMappingAny	(	void *	listener,
		EventBase::EventGeneratorID_t	egid,
		unsigned int	sid
	)			const

Needed to complete EventRouter::isListening suite.

Checks both allevents and filteredevents, can be found in either

Definition at line 836 of file EventRouter.cc.

bool EventRouter::EventMapper::verifyMappingAny	(	void *	listener,
		EventBase::EventGeneratorID_t	egid
	)			const

Needed to complete EventRouter::isListening suite.

Checks both allevents and filteredevents

Definition at line 780 of file EventRouter.cc.

Referenced by EventRouter::isListeningAny(), and EventRouter::isTrappingAny().

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

Tekkotsu v3.0

Generated Fri May 11 20:08:05 2007 by Doxygen 1.4.7