Timer< time > Class Template Reference

#include <AH/Timing/MillisMicrosTimer.hpp>

Detailed Description

template<timefunction time = micros>
class AH::Timer< time >

A class for easily managing timed events.

A wrapper for "Blink Without Delay".

Template Parameters

time	The time function to use.

Definition at line 23 of file MillisMicrosTimer.hpp.

Collaboration diagram for Timer< time >:

Public Member Functions
	Timer (unsigned long interval)
	Constructor.
void	begin ()
	Initialize or reset the timer. The timer will fire immediately.
void	beginNextPeriod ()
	Initialize or reset the timer. The timer will fire after one period.
	operator bool ()
	Update the timer and return true if the event should fire.
unsigned long	getInterval () const
	Get the interval of the timer.
void	setInterval (unsigned long interval)
	Set the interval of the timer.

Private Attributes
unsigned long	interval
unsigned long	previous = 0

Constructor & Destructor Documentation

Timer()

template<timefunction time = micros>

Timer ( unsigned long interval )

inline

Constructor.

Parameters

interval

The interval between two events.

Definition at line 30 of file MillisMicrosTimer.hpp.

Member Function Documentation

begin()

template<timefunction time = micros>

void begin ( )

inline

Initialize or reset the timer. The timer will fire immediately.

Definition at line 36 of file MillisMicrosTimer.hpp.

beginNextPeriod()

template<timefunction time = micros>

void beginNextPeriod ( )

inline

Initialize or reset the timer. The timer will fire after one period.

Definition at line 38 of file MillisMicrosTimer.hpp.

operator bool()

template<timefunction time = micros>

operator bool ( )

inlineexplicit

Update the timer and return true if the event should fire.

Definition at line 40 of file MillisMicrosTimer.hpp.

getInterval()

template<timefunction time = micros>

unsigned long getInterval ( ) const

inline

Get the interval of the timer.

Definition at line 50 of file MillisMicrosTimer.hpp.

setInterval()

template<timefunction time = micros>

void setInterval ( unsigned long interval )

inline

Set the interval of the timer.

Definition at line 52 of file MillisMicrosTimer.hpp.

Member Data Documentation

interval

template<timefunction time = micros>

unsigned long interval

private

Definition at line 55 of file MillisMicrosTimer.hpp.

previous

template<timefunction time = micros>

unsigned long previous = 0

private

Definition at line 56 of file MillisMicrosTimer.hpp.

---

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

• MillisMicrosTimer.hpp