StepTimer Class Reference

#include <FlexTimer.h>

Inheritance diagram for StepTimer:

Public Member Functions
	StepTimer ()
	StepTimer (unsigned long initInterval, boolean startImmediate)
	StepTimer (unsigned long initInterval)
virtual	~StepTimer ()
void	start ()
void	start (unsigned long currMillis)
virtual void	onStart (unsigned long currMillis)
void	step ()
void	step (unsigned long currMillis)
virtual void	onStep (unsigned long currMillis)
void	stop ()
bool	isStarted ()
bool	isUp (unsigned long currMillis)
bool	isUp ()
unsigned long	nextUp ()
unsigned long	timeRemaining (unsigned long currMillis)
unsigned long	timeRemaining ()
unsigned long	getRollovers ()
unsigned long	timeSinceStarted (unsigned long currMillis)
unsigned long	timeSinceStarted ()
unsigned long	timeSinceTriggered (unsigned long currMillis)
unsigned long	timeSinceTriggered ()
virtual unsigned long	getLastUp ()
virtual void	setInterval (unsigned long newInterval)
virtual void	setIntervalImmediate (unsigned long newInterval)
unsigned long	getInterval ()

Static Public Member Functions
static unsigned long	addOffsetWithWrap (unsigned long index, unsigned long offset, unsigned long maximum)
static unsigned long	addOffsetWithWrap (unsigned long index, unsigned long offset)
static unsigned long	subtractOffsetWithWrap (unsigned long index, unsigned long offset, unsigned long maximum)

Protected Attributes
unsigned long	interval =DEFAULT_TIMER_INTERVAL
unsigned long	started =0
unsigned long	nextUpMillis =0
uint16_t	rollovers = 0
unsigned long	pendInterval = 0

Constructor & Destructor Documentation

StepTimer() [1/3]

StepTimer::StepTimer ( )

inline

StepTimer() [2/3]

StepTimer::StepTimer ( unsigned long  initInterval, boolean  startImmediate  )

inline

StepTimer() [3/3]

StepTimer::StepTimer ( unsigned long  initInterval )

inline

~StepTimer()

virtual StepTimer::~StepTimer ( )

inlinevirtual

Member Function Documentation

addOffsetWithWrap() [1/2]

static unsigned long StepTimer::addOffsetWithWrap ( unsigned long  index, unsigned long  offset  )

inlinestatic

addOffsetWithWrap() [2/2]

static unsigned long StepTimer::addOffsetWithWrap ( unsigned long  index, unsigned long  offset, unsigned long  maximum  )

inlinestatic

getInterval()

unsigned long StepTimer::getInterval ( )

inline

getLastUp()

virtual unsigned long StepTimer::getLastUp ( )

inlinevirtual

Reimplemented in FlexTimer.

getRollovers()

unsigned long StepTimer::getRollovers ( )

inline

isStarted()

bool StepTimer::isStarted ( )

inline

isUp() [1/2]

bool StepTimer::isUp ( )

inline

isUp() [2/2]

bool StepTimer::isUp ( unsigned long  currMillis )

inline

nextUp()

unsigned long StepTimer::nextUp ( )

inline

onStart()

virtual void StepTimer::onStart ( unsigned long  currMillis )

inlinevirtual

Reimplemented in FlexTimer.

onStep()

virtual void StepTimer::onStep ( unsigned long  currMillis )

inlinevirtual

Reimplemented in FlexTimer.

setInterval()

void StepTimer::setInterval ( unsigned long  newInterval )

virtual

Reimplemented in FlexTimer, and FFXBase.

setIntervalImmediate()

void StepTimer::setIntervalImmediate ( unsigned long  newInterval )

virtual

start() [1/2]

void StepTimer::start

(

)

start() [2/2]

void StepTimer::start

(

unsigned long

currMillis

)

step() [1/2]

void StepTimer::step

(

)

step() [2/2]

void StepTimer::step

(

unsigned long

currMillis

)

stop()

void StepTimer::stop ( )

inline

subtractOffsetWithWrap()

static unsigned long StepTimer::subtractOffsetWithWrap ( unsigned long  index, unsigned long  offset, unsigned long  maximum  )

inlinestatic

timeRemaining() [1/2]

unsigned long StepTimer::timeRemaining ( )

inline

timeRemaining() [2/2]

unsigned long StepTimer::timeRemaining ( unsigned long  currMillis )

inline

timeSinceStarted() [1/2]

unsigned long StepTimer::timeSinceStarted ( )

inline

timeSinceStarted() [2/2]

unsigned long StepTimer::timeSinceStarted ( unsigned long  currMillis )

inline

timeSinceTriggered() [1/2]

unsigned long StepTimer::timeSinceTriggered ( )

inline

timeSinceTriggered() [2/2]

unsigned long StepTimer::timeSinceTriggered ( unsigned long  currMillis )

inline

Member Data Documentation

interval

unsigned long StepTimer::interval =DEFAULT_TIMER_INTERVAL

protected

nextUpMillis

unsigned long StepTimer::nextUpMillis =0

protected

pendInterval

unsigned long StepTimer::pendInterval = 0

protected

rollovers

uint16_t StepTimer::rollovers = 0

protected

started

unsigned long StepTimer::started =0

protected