Clocks

C++ API clocks definitions. More...

Classes
class	os::rtos::adjustable_clock
	Adjustable (non-steady) clock. More...
class	os::rtos::clock
	Generic clock. More...
class	os::rtos::clock_highres
	High Resolution derived clock. More...
class	os::rtos::clock_rtc
	Real time clock. More...
class	os::rtos::clock_systick
	SysTick derived clock. More...

Variables
clock_highres	os::rtos::hrclock
	The high resolution clock object instance.
clock_rtc	os::rtos::rtclock
	The real time clock object instance.
clock_systick	os::rtos::sysclock
	The system clock object instance.

Types & Constants
using	os::rtos::clock::duration_t = port::clock::duration_t
	Type of variables holding clock durations.
using	os::rtos::clock::timestamp_t = port::clock::timestamp_t
	Type of variables holding clock time stamps.
using	os::rtos::clock::offset_t = port::clock::offset_t
	Type of variables holding clock offsets.

Detailed Description

C++ API clocks definitions.

Examples

// TODO

Typedef Documentation

duration_t

using os::rtos::clock::duration_t = port::clock::duration_t

Type of variables holding clock durations.

A numeric type intended to store a clock duration, either in ticks or in seconds.

Definition at line 76 of file os-clocks.h.

offset_t

using os::rtos::clock::offset_t = port::clock::offset_t

Type of variables holding clock offsets.

A numeric type intended to store a clock offset (difference to epoch), either in ticks or in seconds.

Definition at line 95 of file os-clocks.h.

timestamp_t

using os::rtos::clock::timestamp_t = port::clock::timestamp_t

Type of variables holding clock time stamps.

A numeric type intended to store a clock timestamp, either in ticks or in seconds.

Definition at line 85 of file os-clocks.h.

Variable Documentation

hrclock

clock_highres os::rtos::hrclock

The high resolution clock object instance.

Kind of singleton instance of the clock_highres class.

Definition at line 717 of file os-clocks.cpp.

rtclock

clock_rtc os::rtos::rtclock

The real time clock object instance.

Kind of singleton instance of the clock_rtc class.

Definition at line 666 of file os-clocks.cpp.

sysclock

clock_systick os::rtos::sysclock

The system clock object instance.

Kind of singleton instance of the clock_systick class.

Definition at line 565 of file os-clocks.cpp.