FreeRTOScpp::TimerClass Class Reference

#include <TimerCPP.h>

Inheritance diagram for FreeRTOScpp::TimerClass:

Collaboration diagram for FreeRTOScpp::TimerClass:

Public Member Functions
	TimerClass (char const *name_, TickType_t period_, bool reload)
bool	active ()
TickType_t	expiryTime ()
const char *	name ()
TickType_t	period ()
bool	period (TickType_t period_, TickType_t wait=portMAX_DELAY)
bool	period (Time_ms period_, TickType_t wait=portMAX_DELAY)
bool	period (Time_ms period_, Time_ms wait)
bool	periodISR (TickType_t period_, portBASE_TYPE &waswoken)
bool	periodISR (Time_ms period_, portBASE_TYPE &waswoken)
bool	reset (TickType_t wait=portMAX_DELAY)
bool	reset (Time_ms wait)
bool	resetISR (portBASE_TYPE &waswoken)
bool	start (TickType_t wait=portMAX_DELAY)
bool	start (Time_ms wait)
bool	startISR (portBASE_TYPE &waswoken)
bool	stop (TickType_t wait=portMAX_DELAY)
bool	stop (Time_ms wait)
bool	stopISR (portBASE_TYPE &waswoken)
virtual void	timer ()=0

Protected Attributes
TimerHandle_t	timerHandle

Static Private Member Functions
static void	timerClassCallback (TimerHandle_t timerHandle)

Constructor & Destructor Documentation

TimerClass()

FreeRTOScpp::TimerClass::TimerClass ( char const *  name_, TickType_t  period_, bool  reload  )

inline

Member Function Documentation

active()

bool FreeRTOScpp::Timer::active ( )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

expiryTime()

TickType_t FreeRTOScpp::Timer::expiryTime ( )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

name()

const char* FreeRTOScpp::Timer::name ( )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

period() [1/4]

TickType_t FreeRTOScpp::Timer::period ( )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

period() [2/4]

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

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

period() [3/4]

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

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

period() [4/4]

bool FreeRTOScpp::Timer::period ( Time_ms  period_, Time_ms  wait  )

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

periodISR() [1/2]

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

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

periodISR() [2/2]

bool FreeRTOScpp::Timer::periodISR ( Time_ms  period_, portBASE_TYPE &  waswoken  )

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

reset() [1/2]

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

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

reset() [2/2]

bool FreeRTOScpp::Timer::reset ( Time_ms  wait )

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

resetISR()

bool FreeRTOScpp::Timer::resetISR ( portBASE_TYPE &  waswoken )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

start() [1/2]

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

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

Referenced by FreeRTOScpp::Timer::Timer().

Here is the caller graph for this function:

start() [2/2]

bool FreeRTOScpp::Timer::start ( Time_ms  wait )

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

startISR()

bool FreeRTOScpp::Timer::startISR ( portBASE_TYPE &  waswoken )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

stop() [1/2]

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

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

stop() [2/2]

bool FreeRTOScpp::Timer::stop ( Time_ms  wait )

inlineinherited

References FreeRTOScpp::ms2ticks(), and FreeRTOScpp::Timer::timerHandle.

Here is the call graph for this function:

stopISR()

bool FreeRTOScpp::Timer::stopISR ( portBASE_TYPE &  waswoken )

inlineinherited

References FreeRTOScpp::Timer::timerHandle.

timer()

virtual void FreeRTOScpp::TimerClass::timer ( )

pure virtual

Implemented in FreeRTOScpp::TimerMember< T >.

Referenced by timerClassCallback().

Here is the caller graph for this function:

timerClassCallback()

static void FreeRTOScpp::TimerClass::timerClassCallback ( TimerHandle_t  timerHandle )

inlinestaticprivate

References timer().

Here is the call graph for this function:

Member Data Documentation

timerHandle

TimerHandle_t FreeRTOScpp::Timer::timerHandle

protectedinherited

Referenced by FreeRTOScpp::Timer::active(), FreeRTOScpp::Timer::expiryTime(), FreeRTOScpp::Timer::name(), FreeRTOScpp::Timer::period(), FreeRTOScpp::Timer::periodISR(), FreeRTOScpp::Timer::reset(), FreeRTOScpp::Timer::resetISR(), FreeRTOScpp::Timer::start(), FreeRTOScpp::Timer::startISR(), FreeRTOScpp::Timer::stop(), FreeRTOScpp::Timer::stopISR(), and FreeRTOScpp::Timer::~Timer().

---

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

• TimerCPP.h