Inheritance diagram for Alarmable:

Collaboration diagram for Alarmable:

Public Member Functions
	Alarmable (const Alarmable &)=default

Alarmable &	operator= (const Alarmable &)=default

	Alarmable (Alarmable &&)=default

Alarmable &	operator= (Alarmable &&)=default

Protected Member Functions
void	submitAlarmRegistration (float timeDelay, AlarmID alarmID)
	Submit alarm registration to the current scene. More...

void	submitAlarmDeregistration (AlarmID alarmID)
	Submit alarm deregistration to the current scene. More...

bool	isRegisteredForAlarm (AlarmID alarmID) const
	Query if 'alarmID' is registered. More...

float	getTimeLeftForAlarm (AlarmID alarmID) const
	Gets time left for a given alarm. More...

Private Member Functions
void	registerAlarm (float timeDelay, AlarmID alarmID)
	Registers a alarm to the current scene. More...

void	deregisterAlarm (AlarmID alarmID)
	Deregisters a alarm from the current scene. More...

void	triggerAlarm (AlarmID alarmID)
	Trigger a alarm. Used only by the AlarmableManager More...

virtual void	alarm0 ()
	Alarm 0. More...

virtual void	alarm1 ()
	Alarm 1. More...

virtual void	alarm2 ()
	Alarm 2. More...

void	setDeleteReference (const AlarmableManager::TimeLineReference &, AlarmID)

AlarmableManager::TimeLineReference	getDeleteReference (AlarmID) const

RegistrationData	getRegistrationData (AlarmID) const

RegistrationData &	getRegistrationDataReference (AlarmID)

void	initializeRegistrationData ()

void	deinitializeRegistrationData ()

void	incrementAlarmID (AlarmID &currentID)

Static Private Member Functions
static void	DebugPrint (const std::string &message)

Private Attributes
RegistrationData	_registrationData [AlarmableManager::MAX_NUMBER_OF_ALARMS]

Static Private Attributes
static const std::string	DEBUG_TITLE_MESSAGE = "Alarmable_DEBUG: "

Member Function Documentation

◆ deregisterAlarm()

void Alarmable::deregisterAlarm ( AlarmID alarmID )

private

Deregisters a alarm from the current scene.

DELAYED called with a command. NOT called by the user.

Parameters

alarmID Identifier for the alarm.

void Alarmable::registerAlarm	(	float	timeDelay,
		AlarmID	alarmID
	)

private

Registers a alarm to the current scene.

DELAYED called with a command. NOT called by the user.

Parameters

timeDelay	The time delay.
alarmID	Identifier for the alarm.

void Alarmable::triggerAlarm ( AlarmID alarmID )

private

Trigger a alarm. Used only by the AlarmableManager

Parameters

alarmID Identifier for the alarm.

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