Timer Class Reference

A timer which fires a TimerEvent at a fixed interval. More...

#include <Timer.hpp>

Public Member Functions
	~Timer ()
	Destructor. More...
timespan_s_t	getInterval () const
	Get the interval at which this timer fires. More...
void	setInterval (timespan_s_t interval)
	Set the interval at which this timer fires. More...
bool	isRepeating () const
	Test if this is a repeating timer. More...
void	setRepeating (bool repeating)
	Specify whether this is a repeating or one-shot timer. More...
time_ms_t	getLastFiredTime () const
	Get the time at which this timer last fired. More...

Detailed Description

A timer which fires a TimerEvent at a fixed interval.

Timers are created and managed through a TimerManager. They have a 1-second resolution.

Author

Mark Lindner

Constructor & Destructor Documentation

~Timer()

~Timer

(

)

Destructor.

Member Function Documentation

getInterval()

timespan_s_t getInterval ( ) const

inline

Get the interval at which this timer fires.

getLastFiredTime()

time_ms_t getLastFiredTime ( ) const

inline

Get the time at which this timer last fired.

isRepeating()

bool isRepeating ( ) const

inline

Test if this is a repeating timer.

setInterval()

void setInterval ( timespan_s_t  interval )

inline

Set the interval at which this timer fires.

setRepeating()

void setRepeating ( bool  repeating )

inline

Specify whether this is a repeating or one-shot timer.

---

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

• Timer.hpp
• Timer.cpp