satcat5::freertos::TickTimer Class Reference

Detailed Description

SatCat5 time reference using the FreeRTOS tick counter.

This class implements the TimeRef API, measuring elapsed time using the tick counter, i.e., "xTaskGetTickCount" and "configTICK_RATE_HZ". Time resolution is relatively coarse, but this API is available on any FreeRTOS platform.

Definition at line 19 of file tick_timer.h.

#include <tick_timer.h>

Inheritance diagram for satcat5::freertos::TickTimer:

Collaboration diagram for satcat5::freertos::TickTimer:

Public Member Functions
	TickTimer ()
	Construct the TickTimer object. More...
u32	raw () override
	Get FreeRTOS Tick Count.
TimeVal	now ()
	Create a TimeVal object using the tick-count from raw().
TimeVal	checkpoint_usec (unsigned usec)
	Create an oven-timer, set N microseconds from now. More...
TimeVal	checkpoint_msec (unsigned msec)
	Create an oven-timer, set N milliseconds from now. More...
void	busywait_usec (unsigned usec)
	If timer resolution allows, busywait for X microseconds. More...
u32	ticks_per_sec () const
	Stable accessors for unit conversion. More...
u32	ticks_per_msec () const
	Stable accessors for unit conversion. More...
u32	ticks_per_usec () const
	Stable accessors for unit conversion. More...

Private Attributes
u64 const	m_msec_per_tick
u64 const	m_usec_per_tick
u64 const	m_tick_per_msec
u64 const	m_tick_per_usec

Constructor & Destructor Documentation

TickTimer()

TickTimer::TickTimer

(

)

Construct the TickTimer object.

Automatically calls Timekeeper::suggest_clock.

Definition at line 17 of file tick_timer.cc.

Member Function Documentation

busywait_usec()

void TimeRef::busywait_usec ( unsigned  usec )

inherited

If timer resolution allows, busywait for X microseconds.

(May return immediately if backing reference is too coarse.)

Definition at line 93 of file timeref.cc.

checkpoint_msec()

TimeVal TimeRef::checkpoint_msec ( unsigned  msec )

inherited

Create an oven-timer, set N milliseconds from now.

An over-timer TimeVal is a timestamp a short time in the future. To use it, create the TimeVal and then poll checkpoint_elapsed(). (The returned TimeVal is intended to be used exactly once.)

Definition at line 73 of file timeref.cc.

checkpoint_usec()

TimeVal TimeRef::checkpoint_usec ( unsigned  usec )

inherited

Create an oven-timer, set N microseconds from now.

An over-timer TimeVal is a timestamp a short time in the future. To use it, create the TimeVal and then poll checkpoint_elapsed(). (The returned TimeVal is intended to be used exactly once.)

Definition at line 69 of file timeref.cc.

ticks_per_msec()

u32 satcat5::util::TimeRef::ticks_per_msec ( ) const

inlineinherited

Stable accessors for unit conversion.

If the tick rate is low, these may return zero.

Definition at line 179 of file timeref.h.

ticks_per_sec()

u32 satcat5::util::TimeRef::ticks_per_sec ( ) const

inlineinherited

Stable accessors for unit conversion.

If the tick rate is low, these may return zero.

Definition at line 177 of file timeref.h.

ticks_per_usec()

u32 satcat5::util::TimeRef::ticks_per_usec ( ) const

inlineinherited

Stable accessors for unit conversion.

If the tick rate is low, these may return zero.

Definition at line 181 of file timeref.h.

---

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

• tick_timer.h
• tick_timer.cc