cpp_freertos::Ticks Class Reference

#include <ticks.hpp>

Static Public Member Functions
static TickType_t	GetTicks ()
static TickType_t	GetTicksFromISR ()
static TickType_t	TicksToMs (TickType_t ticks)
static TickType_t	MsToTicks (TickType_t milliseconds)
static TickType_t	SecondsToTicks (TickType_t seconds)

Detailed Description

Class encapsulating FreeRTOS idea of a tick.

Definition at line 53 of file ticks.hpp.

Member Function Documentation

GetTicks()

static TickType_t cpp_freertos::Ticks::GetTicks ( )

inlinestatic

Get the current tick count.

Returns

Current tick count.

Definition at line 61 of file ticks.hpp.

GetTicksFromISR()

static TickType_t cpp_freertos::Ticks::GetTicksFromISR ( )

inlinestatic

Get the current tick count from ISR context.

Returns

Current tick count.

Definition at line 71 of file ticks.hpp.

MsToTicks()

static TickType_t cpp_freertos::Ticks::MsToTicks ( TickType_t  milliseconds )

inlinestatic

Convert from ms to ticks.

Parameters

milliseconds

milliseconds to convert.

Returns

ticks

Definition at line 93 of file ticks.hpp.

SecondsToTicks()

static TickType_t cpp_freertos::Ticks::SecondsToTicks ( TickType_t  seconds )

inlinestatic

Convert from seconds to ticks.

Parameters

seconds

seconds to convert.

Returns

ticks

Definition at line 104 of file ticks.hpp.

TicksToMs()

static TickType_t cpp_freertos::Ticks::TicksToMs ( TickType_t  ticks )

inlinestatic

Convert from ticks to ms.

Parameters

ticks

ticks to convert.

Returns

milliseconds.

Definition at line 82 of file ticks.hpp.

---

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

• ticks.hpp