AH::Timer< time > Class Template Reference

A class for easily managing timed events. More...

#include <MillisMicrosTimer.hpp>

Collaboration diagram for AH::Timer< time >:

Public Member Functions
	Timer (unsigned long interval)
	Constructor. More...
void	begin ()
	Initialize the timer. More...
	operator bool ()
	Update the timer and return true if the event should fire. More...

Private Attributes
const unsigned long	interval
unsigned long	previous = 0

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 28 of file MillisMicrosTimer.hpp.

Constructor & Destructor Documentation

Timer()

template<timefunction time = micros>

AH::Timer< time >::Timer ( unsigned long  interval )

inline

Constructor.

Parameters

interval

The interval between two events.

Definition at line 35 of file MillisMicrosTimer.hpp.

Member Function Documentation

begin()

template<timefunction time = micros>

void AH::Timer< time >::begin ( )

inline

Initialize the timer.

Definition at line 41 of file MillisMicrosTimer.hpp.

operator bool()

template<timefunction time = micros>

AH::Timer< time >::operator bool ( )

inlineexplicit

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

Definition at line 43 of file MillisMicrosTimer.hpp.

Member Data Documentation

interval

template<timefunction time = micros>

const unsigned long AH::Timer< time >::interval

private

Definition at line 53 of file MillisMicrosTimer.hpp.

previous

template<timefunction time = micros>

unsigned long AH::Timer< time >::previous = 0

private

Definition at line 54 of file MillisMicrosTimer.hpp.

---

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

• MillisMicrosTimer.hpp