Slippers Engine
 
Loading...
Searching...
No Matches
Alarmable Class Reference

Responsible for Alarm functions. More...

#include <Alarmable.h>

Collaboration diagram for Alarmable:
Collaboration graph

Protected Member Functions

void SubmitRegistration (float t, AlarmableManager::ALARM_ID id)
 Called when wanting to start an alarm.
 
void SubmitDeregistration (AlarmableManager::ALARM_ID id)
 Called when wanting to cancel an alarm.
 

Private Member Functions

void AddTime (AlarmableManager::ALARM_ID id, float f)
 Adjusts the time of an alarm.
 
bool AlarmActive (AlarmableManager::ALARM_ID id)
 Returns true if an alarm is active or pending registration.
 
float TimeUntil (AlarmableManager::ALARM_ID id)
 Returns time until alarm activates.
 
virtual void Alarm0 ()
 
virtual void Alarm1 ()
 
virtual void Alarm2 ()
 
virtual void Alarm3 ()
 
virtual void Alarm4 ()
 

Detailed Description

Responsible for Alarm functions.

Member Function Documentation

◆ AddTime()

void Alarmable::AddTime ( AlarmableManager::ALARM_ID id,
float f )
private

Adjusts the time of an alarm.

This function adds or subtracts time to a given alarm id. If time is subtracted past the remaining time, then the alarm will set itself off.

Parameters
id
f

◆ Alarm0()

virtual void Alarmable::Alarm0 ( )
privatevirtual

◆ Alarm1()

virtual void Alarmable::Alarm1 ( )
privatevirtual

◆ Alarm2()

virtual void Alarmable::Alarm2 ( )
privatevirtual

◆ Alarm3()

virtual void Alarmable::Alarm3 ( )
privatevirtual

◆ Alarm4()

virtual void Alarmable::Alarm4 ( )
privatevirtual

◆ AlarmActive()

bool Alarmable::AlarmActive ( AlarmableManager::ALARM_ID id)
private

Returns true if an alarm is active or pending registration.

Parameters
id
Returns
bool

◆ SubmitDeregistration()

void Alarmable::SubmitDeregistration ( AlarmableManager::ALARM_ID id)
protected

Called when wanting to cancel an alarm.

Example:

void SubmitDeregistration(AlarmableManager::ALARM_ID id)
Called when wanting to cancel an alarm.
Definition Alarmable.cpp:111
@ ALARM_0
Definition AlarmableManager.h:15
Parameters
id

◆ SubmitRegistration()

void Alarmable::SubmitRegistration ( float t,
AlarmableManager::ALARM_ID id )
protected

Called when wanting to start an alarm.

Use this function to specify the amount of time you want for your alarm as well as its given id.

Warning
Only one of each alarm can be active at any given moment.

Example:

void SubmitRegistration(float t, AlarmableManager::ALARM_ID id)
Called when wanting to start an alarm.
Definition Alarmable.cpp:101
Parameters
t
id

◆ TimeUntil()

float Alarmable::TimeUntil ( AlarmableManager::ALARM_ID id)
private

Returns time until alarm activates.

Returns -1 if an alarm is not currently active.

Parameters
t
id