FreeRTOScpp
Loading...
Searching...
No Matches
Timer Class Reference

#include <TimerCPP.h>

Inheritance diagram for Timer:
Collaboration diagram for Timer:

Public Member Functions

 Timer (char const *name_, void(*func)(TimerHandle_t handle), TickType_t period_, bool reload, bool start_)
 
virtual ~Timer ()
 
bool active ()
 
TickType_t expiryTime ()
 
const char * name ()
 
TickType_t period ()
 
bool period (TickType_t period_, TickType_t wait=portMAX_DELAY)
 
bool periodISR (TickType_t period_, portBASE_TYPE &waswoken)
 
bool reset (TickType_t wait=portMAX_DELAY)
 
bool resetISR (portBASE_TYPE &waswoken)
 
bool start (TickType_t wait=portMAX_DELAY)
 
bool startISR (portBASE_TYPE &waswoken)
 
bool stop (TickType_t wait=portMAX_DELAY)
 
bool stopISR (portBASE_TYPE &waswoken)
 

Protected Attributes

TimerHandle_t timerHandle
 

Constructor & Destructor Documentation

◆ Timer()

Timer::Timer ( char const * name_,
void(* func )(TimerHandle_t handle),
TickType_t period_,
bool reload,
bool start_ )
inline

◆ ~Timer()

virtual Timer::~Timer ( )
inlinevirtual

Member Function Documentation

◆ active()

bool Timer::active ( )
inline

◆ expiryTime()

TickType_t Timer::expiryTime ( )
inline

◆ name()

const char * Timer::name ( )
inline

◆ period() [1/2]

TickType_t Timer::period ( )
inline

◆ period() [2/2]

bool Timer::period ( TickType_t period_,
TickType_t wait = portMAX_DELAY )
inline

◆ periodISR()

bool Timer::periodISR ( TickType_t period_,
portBASE_TYPE & waswoken )
inline

◆ reset()

bool Timer::reset ( TickType_t wait = portMAX_DELAY)
inline

◆ resetISR()

bool Timer::resetISR ( portBASE_TYPE & waswoken)
inline

◆ start()

bool Timer::start ( TickType_t wait = portMAX_DELAY)
inline

◆ startISR()

bool Timer::startISR ( portBASE_TYPE & waswoken)
inline

◆ stop()

bool Timer::stop ( TickType_t wait = portMAX_DELAY)
inline

◆ stopISR()

bool Timer::stopISR ( portBASE_TYPE & waswoken)
inline

Member Data Documentation

◆ timerHandle

TimerHandle_t Timer::timerHandle
protected

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