Callback timer class. More...

#include <Timer.h>

Inheritance diagram for Timer:
[legend]
Collaboration diagram for Timer:
[legend]

Protected Member Functions

void expired ()
 
- Protected Member Functions inherited from OsTimer64Api< Timer >
void longTick ()
 
 OsTimer64Api ()
 
 ~OsTimer64Api ()
 
bool isArmed () const
 
TickType ticks () const
 
void setCallback (TimerCallback callback, void *arg)
 
void setCallback (TimerDelegate delegateFunction)
 
void setInterval (TickType interval)
 
TickType getInterval () const
 
void arm (bool repeating)
 
void disarm ()
 
- Protected Member Functions inherited from CallbackTimerApi< OsTimer64Api< Timer > >
String name () const
 
String toString () const
 
 operator String () const
 

Protected Attributes

friend OsTimer64Api< Timer >
 
- Protected Attributes inherited from CallbackTimer< OsTimer64Api< Timer > >
bool callbackSet
 User has provided callback function. More...
 
bool intervalSet
 User has set valid time interval. More...
 
bool repeating
 Timer is auto-repeat. More...
 
bool started
 Timer is active, or has fired. More...
 
- Protected Attributes inherited from OsTimer64Api< Timer >
TimerCallback func
 
void * arg
 

Additional Inherited Members

- Public Types inherited from CallbackTimer< OsTimer64Api< Timer > >
using Millis = NanoTime::TimeSource< Clock, NanoTime::Milliseconds, uint32_t >
 
using Micros = NanoTime::TimeSource< Clock, NanoTime::Microseconds, TimeType >
 
- Public Member Functions inherited from DelegateCallbackTimer< OsTimer64Api< Timer > >
DelegateCallbackTimerinitializeUs (TimerDelegate delegateFunction)
 Initialise timer in microseconds, with static check. More...
 
DelegateCallbackTimerinitializeUs (uint32_t microseconds, TimerDelegate delegateFunction)
 Initialise microsecond timer. More...
 
DelegateCallbackTimerinitializeMs (TimerDelegate delegateFunction)
 Initialise hardware timer in milliseconds, with static check. More...
 
DelegateCallbackTimerinitializeMs (uint32_t milliseconds, TimerDelegate delegateFunction)
 Initialise millisecond timer. More...
 
void setCallback (TimerDelegate delegateFunction)
 Set timer trigger function using Delegate callback method. More...
 
- Public Member Functions inherited from CallbackTimer< OsTimer64Api< Timer > >
CallbackTimerinitialize (TimerCallback callback, void *arg=nullptr)
 Initialise timer with an interval (static check) and callback. More...
 
CallbackTimerinitialize (TimeType time, TimerCallback callback, void *arg=nullptr)
 Initialise timer with an interval and callback. More...
 
CallbackTimerinitializeUs (TimerCallback callback, void *arg=nullptr)
 Initialise timer in microseconds (static check) with Timer Callback and optional argument. More...
 
CallbackTimerinitializeUs (InterruptCallback callback=nullptr)
 Initialise timer in microseconds (static check) with optional Interrupt Callback (no argument) More...
 
CallbackTimerinitializeUs (TimeType microseconds, TimerCallback callback, void *arg=nullptr)
 Initialise timer in microseconds with Timer Callback and optional argument. More...
 
CallbackTimerinitializeUs (TimeType microseconds, InterruptCallback callback=nullptr)
 Initialise timer in microseconds with optional Interrupt Callback (no arg) More...
 
CallbackTimerinitializeMs (TimerCallback callback, void *arg=nullptr)
 Initialise hardware timer in milliseconds (static check) with Timer Callback and optional argument. More...
 
CallbackTimerinitializeMs (InterruptCallback callback=nullptr)
 Initialise hardware timer in milliseconds (static check) and optional Interrupt Callback (no arg) More...
 
CallbackTimerinitializeMs (uint32_t milliseconds, TimerCallback callback, void *arg=nullptr)
 Initialise hardware timer in milliseconds with Timer Callback and optional argument. More...
 
CallbackTimerinitializeMs (uint32_t milliseconds, InterruptCallback callback=nullptr)
 Initialise hardware timer in milliseconds with optional Interrupt Callback (no arg) More...
 
bool start (bool repeating=true)
 Start timer running. More...
 
bool startOnce ()
 Start one-shot timer. More...
 
void stop ()
 Stops timer. More...
 
bool restart ()
 Restart timer. More...
 
bool isStarted () const
 Check if timer is started. More...
 
NanoTime::Time< TimeTypegetIntervalUs () const
 Get timer interval in microseconds. More...
 
NanoTime::Time< uint32_t > getIntervalMs () const
 Get timer interval in milliseconds. More...
 
TickType getInterval () const
 Get timer interval in clock ticks. More...
 
bool checkInterval (TickType ticks) const
 Check timer interval is valid. More...
 
bool setInterval (TickType ticks)
 Set timer interval in timer ticks. More...
 
void setInterval ()
 Set timer interval in timer ticks (static check) More...
 
void setInterval ()
 Set timer interval in specific time unit (static check) More...
 
bool setInterval (TimeType time)
 Set timer interval in timer ticks. More...
 
bool setIntervalUs (TimeType microseconds)
 Set timer interval in microseconds. More...
 
void setIntervalUs ()
 Set timer interval in microseconds (static check) More...
 
bool setIntervalMs (uint32_t milliseconds)
 Set timer interval in milliseconds. More...
 
void setIntervalMs ()
 Set timer interval in milliseconds (static check) More...
 
void setCallback (TimerCallback callback, void *arg=nullptr)
 Set timer trigger callback. More...
 
void setCallback (InterruptCallback callback)
 Set timer trigger callback. More...
 
- Static Public Member Functions inherited from CallbackTimer< OsTimer64Api< Timer > >
static constexpr Millis millis ()
 Get a millisecond time source. More...
 
static constexpr Micros micros ()
 Get a microsecond time source. More...
 
static constexpr uint64_t usToTicks ()
 Convert microsecond count into timer ticks. More...
 
static TickType usToTicks (TimeType time)
 Convert microsecond count into timer ticks. More...
 
static constexpr uint64_t ticksToUs ()
 Convert timer ticks into microseconds. More...
 
static TimeType ticksToUs (TickType ticks)
 Convert timer ticks into microseconds. More...
 
static constexpr void checkInterval ()
 Check timer interval in ticks is valid (static check) More...
 
static constexpr void checkInterval ()
 Check timer interval in specific time unit is valid (static check) More...
 
static constexpr void checkIntervalMs ()
 Check timer interval in milliseconds is valid (static check) More...
 
static constexpr void checkIntervalUs ()
 Check timer interval in microseconds is valid (static check) More...
 
- Protected Types inherited from OsTimer64Api< Timer >
using Clock = OsTimerApi::Clock
 
using TickType = uint64_t
 
using TimeType = uint64_t
 
- Static Protected Member Functions inherited from OsTimer64Api< Timer >
static constexpr const char * typeName ()
 
static constexpr TickType minTicks ()
 
static constexpr TickType maxTicks ()
 
- Static Protected Member Functions inherited from CallbackTimerApi< OsTimer64Api< Timer > >
static constexpr const char * typeName ()
 

Detailed Description

Callback timer class.

Member Function Documentation

◆ expired()

void Timer::expired ( )
inlineprotected

Member Data Documentation

◆ OsTimer64Api< Timer >

friend Timer::OsTimer64Api< Timer >
protected

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