Alarmable Class Reference

#include <Alarmable.h>

Inheritance diagram for Alarmable:

Collaboration diagram for Alarmable:

Classes
struct	RegistrationData
	The registration data for alarms. More...

Public Member Functions
	Alarmable ()
	Default constructor. More...
	Alarmable (const Alarmable &)=delete
	Copy constructor. More...
	Alarmable (Alarmable &&)=delete
	Move constructor. More...
Alarmable &	operator= (const Alarmable &)=delete
	Assignment operator. More...
Alarmable &	operator= (Alarmable &&)=delete
	Move assignment operator. More...
virtual	~Alarmable ()
	Deconstructor. More...

Protected Member Functions
void	SubmitAlarmRegistration (int id, float t)
	Submit alarm registration. More...
void	SubmitAlarmRegistration (AlarmableManager::ALARM_ID id, float t)
	Submit alarm registration. More...
void	SubmitAlarmDeregistration (int id)
	Submit alarm deregistration. More...
void	SubmitAlarmDeregistration (AlarmableManager::ALARM_ID id)
	Submit alarm deregistration. More...

Private Member Functions
virtual void	Alarm0 ()
virtual void	Alarm1 ()
virtual void	Alarm2 ()
virtual void	Alarm3 ()
virtual void	Alarm4 ()
AlarmableManager::StorageEntryRef	GetStorageRef (AlarmableManager::ALARM_ID inputId)
	Gets storage reference. More...
void	AlarmRegistration (AlarmableManager::ALARM_ID id, float t)
	Alarm registration. More...
void	AlarmDeregistration (AlarmableManager::ALARM_ID id)
	Alarm deregistration. More...
void	TriggerAlarm (AlarmableManager::ALARM_ID id)
	Trigger alarm. More...

Private Attributes
RegistrationData	RegData [AlarmableManager::ALARM_NUMBER]
	Registration data array. More...

Friends
class	AlarmableAttorney

Constructor & Destructor Documentation

Alarmable() [1/3]

Alarmable::Alarmable

(

)

Default constructor.

Alarmable() [2/3]

Alarmable::Alarmable ( const Alarmable &  )

delete

Copy constructor.

Alarmable() [3/3]

Alarmable::Alarmable ( Alarmable &&  )

delete

Move constructor.

~Alarmable()

Alarmable::~Alarmable ( )

virtual

Deconstructor.

Member Function Documentation

Alarm0()

void Alarmable::Alarm0 ( )

privatevirtual

Reimplemented in ParticleEmitter.

Here is the caller graph for this function:

Alarm1()

void Alarmable::Alarm1 ( )

privatevirtual

Reimplemented in ParticleEmitter.

Here is the caller graph for this function:

Alarm2()

void Alarmable::Alarm2 ( )

privatevirtual

Here is the caller graph for this function:

Alarm3()

void Alarmable::Alarm3 ( )

privatevirtual

Here is the caller graph for this function:

Alarm4()

void Alarmable::Alarm4 ( )

privatevirtual

Here is the caller graph for this function:

AlarmDeregistration()

void Alarmable::AlarmDeregistration ( AlarmableManager::ALARM_ID  id )

private

Alarm deregistration.

Parameters

id	The alarm identifier.

Here is the call graph for this function:

Here is the caller graph for this function:

AlarmRegistration()

void Alarmable::AlarmRegistration ( AlarmableManager::ALARM_ID  id, float  t  )

private

Alarm registration.

Parameters

id	The identifier.
t	A float, delta t until trigger time.

Here is the call graph for this function:

Here is the caller graph for this function:

GetStorageRef()

AlarmableManager::StorageEntryRef Alarmable::GetStorageRef ( AlarmableManager::ALARM_ID  inputId )

private

Gets storage reference.

Parameters

inputId

Identifier for the alarm.

Returns

The storage reference for the specified alarm.

Here is the caller graph for this function:

operator=() [1/2]

Alarmable& Alarmable::operator= ( Alarmable &&  )

delete

Move assignment operator.

operator=() [2/2]

Alarmable& Alarmable::operator= ( const Alarmable &  )

delete

Assignment operator.

SubmitAlarmDeregistration() [1/2]

void Alarmable::SubmitAlarmDeregistration ( AlarmableManager::ALARM_ID  id )

protected

Submit alarm deregistration.

Parameters

id	The alarm identifier.

Here is the call graph for this function:

SubmitAlarmDeregistration() [2/2]

void Alarmable::SubmitAlarmDeregistration ( int  id )

protected

Submit alarm deregistration.

Parameters

id	The alarm identifier.

SubmitAlarmRegistration() [1/2]

void Alarmable::SubmitAlarmRegistration ( AlarmableManager::ALARM_ID  id, float  t  )

protected

Submit alarm registration.

Parameters

id	The alarm identifier.
t	A float, delta t for alarm trigger time.

Here is the call graph for this function:

SubmitAlarmRegistration() [2/2]

void Alarmable::SubmitAlarmRegistration ( int  id, float  t  )

protected

Submit alarm registration.

Parameters

id	The alarm number.
t	A float, delta t for alarm trigger time.

Here is the caller graph for this function:

TriggerAlarm()

void Alarmable::TriggerAlarm ( AlarmableManager::ALARM_ID  id )

private

Trigger alarm.

Parameters

id	The alarm identifier.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

AlarmableAttorney

friend class AlarmableAttorney

friend

Member Data Documentation

RegData

RegistrationData Alarmable::RegData[AlarmableManager::ALARM_NUMBER]

private

Registration data array.

---

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

• Alarmable.h
• Alarmable.cpp