Nimbus::GenericHandler Class Reference

#include <GenericHandler.h>

Inheritance diagram for Nimbus::GenericHandler:

Collaboration diagram for Nimbus::GenericHandler:

Public Member Functions
	GenericHandler ()
virtual void	handleEvent (payloadmap payload, EventListener *responder=NULL)
virtual void	registerListener (EventListener *listener, filtermap filter=filtermap())
virtual void	unregisterListener (EventListener *listener, filtermap filter=filtermap())
virtual bool	isEmpty ()

Additional Inherited Members
Public Types inherited from Nimbus::EventTypeHandler
enum	HandlerTypes { GENERIC, ENTITY, ENTITY_GROUP }
Public Attributes inherited from Nimbus::EventTypeHandler
enum Nimbus::EventTypeHandler::HandlerTypes	mHandlerType
Protected Member Functions inherited from Nimbus::EventTypeHandler
	EventTypeHandler (HandlerTypes type)

Detailed Description

A simple, generic handler for any events that don't require (or permit) special filtering.

Constructor & Destructor Documentation

GenericHandler::GenericHandler

(

)

Creates a generic handler.

Member Function Documentation

void GenericHandler::handleEvent ( payloadmap  payload, EventListener *  responder = NULL  )

virtual

Handle the event as efficiently as possible for this type of event. This function enables us to write specialized filters for each type of event that needs a special filter.

Implements Nimbus::EventTypeHandler.

bool GenericHandler::isEmpty ( )

virtual

Indicates if the handler is empty of listeners.

Returns

True if the handler contains no listeners.

Implements Nimbus::EventTypeHandler.

void GenericHandler::registerListener ( EventListener *  listener, filtermap  filter = filtermap()  )

virtual

Registers a listener with the event handler.

Parameters

listener	A pointer to the event listener which should be registered.
filter	A filtermap which contains the filter for the event handler to classify the listener.

Implements Nimbus::EventTypeHandler.

void GenericHandler::unregisterListener ( EventListener *  listener, filtermap  filter = filtermap()  )

virtual

Unregisters a listener with the event handler.

Parameters

listener	A pointer to the event listener which should be unregistered.
filter	A filtermap which contains the filter for the event handler to classify the listener.

Implements Nimbus::EventTypeHandler.

---

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

• C:/Users/Hazen/Documents/projects/Nimbus/src/EventSystem/GenericHandler.h
• C:/Users/Hazen/Documents/projects/Nimbus/src/EventSystem/GenericHander.cpp