Timer1Api< clkdiv, mode > Class Template Reference
Class template for Timer1 API. More...
#include <HardwareTimer.h>
Inheritance diagram for Timer1Api< clkdiv, mode >:
Collaboration diagram for Timer1Api< clkdiv, mode >:
Public Types | |
using | Clock = Timer1Clock< clkdiv > |
using | TickType = uint32_t |
using | TimeType = uint32_t |
Public Member Functions | |
Timer1Api () | |
~Timer1Api () | |
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 () |
static TickType | ticks () |
static void | setCallback (TimerCallback callback, void *arg) |
static void | setInterval (TickType interval) |
static TickType | getInterval () |
static bool | isArmed () |
static void | arm (bool repeating) |
static void | disarm () |
Detailed Description
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
class Timer1Api< clkdiv, mode >
Class template for Timer1 API.
- Note
- Provides low-level interface for timer access
Member Typedef Documentation
◆ Clock
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
using Timer1Api< clkdiv, mode >::Clock = Timer1Clock<clkdiv> |
◆ TickType
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
using Timer1Api< clkdiv, mode >::TickType = uint32_t |
◆ TimeType
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
using Timer1Api< clkdiv, mode >::TimeType = uint32_t |
Constructor & Destructor Documentation
◆ Timer1Api()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inline |
◆ ~Timer1Api()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inline |
Member Function Documentation
◆ arm()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ disarm()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ getInterval()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ isArmed()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ maxTicks()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ minTicks()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ name()
|
inlineinherited |
◆ operator String()
|
inlineinherited |
◆ setCallback()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ setInterval()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ ticks()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
◆ toString()
|
inlineinherited |
◆ typeName()
template<hw_timer_clkdiv_t clkdiv, HardwareTimerMode mode>
|
inlinestatic |
The documentation for this class was generated from the following file: