OsTimerApi Class Reference

Implements common system callback timer API. More...

#include <SimpleTimer.h>

Inheritance diagram for OsTimerApi:

Collaboration diagram for OsTimerApi:

Public Types
using	Clock = Timer2Clock
using	TickType = uint32_t
using	TimeType = uint32_t

Public Member Functions
bool	isArmed () const
TickType	ticks () const
	~OsTimerApi ()
void	setCallback (TimerCallback callback, void *arg)
void	setInterval (TickType interval)
TickType	getInterval () const
void	arm (bool repeating)
void	disarm ()
String	name () const
String	toString () const
	operator String () const

Static Public Member Functions
static constexpr const char *	typeName ()
static constexpr TickType	minTicks ()
static constexpr TickType	maxTicks ()

Detailed Description

Implements common system callback timer API.

Member Typedef Documentation

Clock

using OsTimerApi::Clock = Timer2Clock

TickType

using OsTimerApi::TickType = uint32_t

TimeType

using OsTimerApi::TimeType = uint32_t

Constructor & Destructor Documentation

~OsTimerApi()

OsTimerApi::~OsTimerApi ( )

inline

Member Function Documentation

arm()

void OsTimerApi::arm ( bool  repeating )

inline

disarm()

void OsTimerApi::disarm ( )

inline

getInterval()

TickType OsTimerApi::getInterval ( ) const

inline

isArmed()

bool OsTimerApi::isArmed ( ) const

inline

maxTicks()

static constexpr TickType OsTimerApi::maxTicks ( )

inlinestatic

minTicks()

static constexpr TickType OsTimerApi::minTicks ( )

inlinestatic

name()

String CallbackTimerApi< OsTimerApi >::name ( ) const

inlineinherited

operator String()

CallbackTimerApi< OsTimerApi >::operator String ( ) const

inlineinherited

setCallback()

void OsTimerApi::setCallback ( TimerCallback  callback, void *  arg  )

inline

setInterval()

void OsTimerApi::setInterval ( TickType  interval )

inline

ticks()

TickType OsTimerApi::ticks ( ) const

inline

toString()

String CallbackTimerApi< OsTimerApi >::toString ( ) const

inlineinherited

typeName()

static constexpr const char* OsTimerApi::typeName ( )

inlinestatic

---

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

• SimpleTimer.h