Class eva::DelayTimer¶

ClassList > eva > DelayTimer

One-shot timer that fires after a delay.

#include <evaDelayTimer.h>

Inherits the following classes: eva::Tickable

Inherited by the following classes: eva::CountdownTimer, eva::RepeatTimer

Public Functions¶

Type	Name
	DelayTimer () Constructs a DelayTimer with no listener.
	DelayTimer (IHandler * listener) Constructs a DelayTimer with a listener.
bool	isRunning () Checks if the timer is currently active.
DelayTimer *	setListener (IHandler * listener) Assigns or changes the event listener.
void	start (unsigned short delay, IHandler * listener) Starts the timer.
void	start (unsigned short delay) Starts the timer.
void	stop () Stops the timer.

Public Functions inherited from eva::Tickable¶

See eva::Tickable

Type	Name
	Tickable ()
	Tickable (const Tickable &) = delete
	Tickable (Tickable &&) = delete
Tickable &	operator= (const Tickable &) = delete
Tickable &	operator= (Tickable &&) = delete
virtual	~Tickable ()

Public Static Functions inherited from eva::Tickable¶

See eva::Tickable

Type	Name
void	tac () Triggers tick on this and all linked tickables.

Protected Attributes¶

Type	Name
IHandler *	listener
unsigned long	nextFire

Protected Functions¶

Type	Name
bool	checkTimeElapsed ()
virtual void	tick () override

Public Functions Documentation¶

function DelayTimer [1/2]¶

Constructs a DelayTimer with no listener.

eva::DelayTimer::DelayTimer ()

function DelayTimer [2/2]¶

Constructs a DelayTimer with a listener.

eva::DelayTimer::DelayTimer (
    IHandler * listener
)

Parameters:

listener Handler to invoke when timer expires

function isRunning¶

Checks if the timer is currently active.

bool eva::DelayTimer::isRunning ()

Returns:

true if timer is running and will fire, false otherwise

function setListener¶

Assigns or changes the event listener.

DelayTimer * eva::DelayTimer::setListener (
    IHandler * listener
)

Parameters:

listener Pointer to IHandler implementation that will receive timer events

Returns:

Pointer to this DelayTimer instance for method chaining

function start [1/2]¶

Starts the timer.

void eva::DelayTimer::start (
    unsigned short delay,
    IHandler * listener
)

Parameters:

delay Delay in milliseconds
listener Handler to invoke when timer expires

function start [2/2]¶

Starts the timer.

void eva::DelayTimer::start (
    unsigned short delay
)

Parameters:

delay Delay in milliseconds

Listener must be assigned via constructor or setListener(). Use overloaded version with listener parameter if not pre-assigned.

function stop¶

Stops the timer.

void eva::DelayTimer::stop ()

Protected Attributes Documentation¶

variable listener¶

IHandler* eva::DelayTimer::listener;

variable nextFire¶

unsigned long eva::DelayTimer::nextFire;

Protected Functions Documentation¶

function checkTimeElapsed¶

bool eva::DelayTimer::checkTimeElapsed ()

function tick¶

virtual void eva::DelayTimer::tick () override

Implements eva::Tickable::tick

The documentation for this class was generated from the following file src/evaDelayTimer.h