Ocean::EventManager::RegistrationRequest Class Reference

Definition of a class encapsulating a registration request. More...

Public Member Functions
	RegistrationRequest (const bool registerCallback, const unsigned int id, const unsigned int eventTypes, const EventCallback &callback)
	Creates a new registration request. More...
bool	registerCallback () const
	Returns whether the request intends an register or unregister execution. More...
unsigned int	id () const
	Returns the registration request id of this object. More...
unsigned int	eventTypes () const
	Returns the event types for which the callback function will be registered or unregistered. More...
const EventCallback &	callback () const
	Returns the callback function of this request object. More...

Protected Attributes
bool	requestRegisterCallback
	True, to register the callback function; False, to unregister the callback function. More...
unsigned int	requestId
	The registration request id of the new object. More...
unsigned int	requestEventTypes
	The event types for which the callback function will be registered or unregistered. More...
EventCallback	requestCallback
	The callback function of this request. More...

Detailed Description

Definition of a class encapsulating a registration request.

Constructor & Destructor Documentation

RegistrationRequest()

Ocean::EventManager::RegistrationRequest::RegistrationRequest ( const bool  registerCallback, const unsigned int  id, const unsigned int  eventTypes, const EventCallback &  callback  )

inline

Creates a new registration request.

Parameters

registerCallback	True, to register the callback function; False, to unregister the callback function
id	The registration request id of the new object
eventTypes	The event type(s) for which the callback function will be registered or unregistered
callback	The callback function

Member Function Documentation

callback()

const EventManager::EventCallback & Ocean::EventManager::RegistrationRequest::callback ( ) const

inline

Returns the callback function of this request object.

Returns

The callback function

eventTypes()

unsigned int Ocean::EventManager::RegistrationRequest::eventTypes ( ) const

inline

Returns the event types for which the callback function will be registered or unregistered.

Returns

The event types

id()

unsigned int Ocean::EventManager::RegistrationRequest::id ( ) const

inline

Returns the registration request id of this object.

Returns

The request id

registerCallback()

bool Ocean::EventManager::RegistrationRequest::registerCallback ( ) const

inline

Returns whether the request intends an register or unregister execution.

Returns

True, to register the callback function; False, to unregister the callback function

Field Documentation

requestCallback

EventCallback Ocean::EventManager::RegistrationRequest::requestCallback

protected

The callback function of this request.

requestEventTypes

unsigned int Ocean::EventManager::RegistrationRequest::requestEventTypes

protected

The event types for which the callback function will be registered or unregistered.

requestId

unsigned int Ocean::EventManager::RegistrationRequest::requestId

protected

The registration request id of the new object.

requestRegisterCallback

bool Ocean::EventManager::RegistrationRequest::requestRegisterCallback

protected

True, to register the callback function; False, to unregister the callback function.

---

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

• Event.h