FreeRTOScpp::Timer Class Reference

#include <TimerCPP.h>

Inheritance diagram for FreeRTOScpp::Timer:

Collaboration diagram for FreeRTOScpp::Timer:

Public Member Functions
	Timer (char const *name_, void(*func)(TimerHandle_t handle), TickType_t period_, bool reload, bool start_)
	Timer (char const *name_, void(*func)(TimerHandle_t handle), Time_ms 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	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)

Protected Attributes
TimerHandle_t	timerHandle

Constructor & Destructor Documentation

Timer() [1/2]

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

inline

References start().

Here is the call graph for this function:

Timer() [2/2]

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

inline

References start().

Here is the call graph for this function:

~Timer()

virtual FreeRTOScpp::Timer::~Timer ( )

inlinevirtual

References timerHandle.

Member Function Documentation

active()

bool FreeRTOScpp::Timer::active ( )

inline

References timerHandle.

expiryTime()

TickType_t FreeRTOScpp::Timer::expiryTime ( )

inline

References timerHandle.

name()

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

inline

References timerHandle.

period() [1/4]

TickType_t FreeRTOScpp::Timer::period ( )

inline

References timerHandle.

period() [2/4]

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

inline

References timerHandle.

period() [3/4]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

period() [4/4]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

periodISR() [1/2]

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

inline

References timerHandle.

periodISR() [2/2]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

reset() [1/2]

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

inline

References timerHandle.

reset() [2/2]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

resetISR()

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

inline

References timerHandle.

start() [1/2]

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

inline

References timerHandle.

Referenced by Timer().

Here is the caller graph for this function:

start() [2/2]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

startISR()

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

inline

References timerHandle.

stop() [1/2]

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

inline

References timerHandle.

stop() [2/2]

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

inline

References FreeRTOScpp::ms2ticks(), and timerHandle.

Here is the call graph for this function:

stopISR()

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

inline

References timerHandle.

Member Data Documentation

timerHandle

TimerHandle_t FreeRTOScpp::Timer::timerHandle

protected

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

---

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

• TimerCPP.h