imt::base::dff::runtime::RuntimeTimer Class Reference

RuntimeTimer defines the basic Application Interface (API) to the timer part of the run to completion (RTC) kernel. More...

#include <Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/RuntimeTimer.h>

Inheritance diagram for imt::base::dff::runtime::RuntimeTimer:

Classes
struct	TimeItem
	TimeItem Object Structure. More...

Public Types
using	TimerHandle = int16_t
	A TimerHandle is used to identify a timer with a unique number.

Static Public Member Functions
static void	initTimerModule (uint32_t initialTimeMs=0)
	Initialize software timer module.
static TimerHandle	startOneShotTimer (RuntimeCore::CoreHandle const apHandle, TimerHandle timerToStart, uint32_t const timerTicksMs)
	Starts or restarts the given one shot timer.
static TimerHandle	startPeriodicTimer (RuntimeCore::CoreHandle const apHandle, TimerHandle timerToStart, uint32_t const intervalMs)
	Starts a periodic timer.
static TimerHandle	updatePeriodicTimer (TimerHandle timerToUpdate, uint32_t const intervalMs)
	Update the intervalMs of an active periodic timer.
static TimerHandle	killTimer (TimerHandle timerToKill)
	Kill an existing timer.
static void	process1msTick ()
	Process the 1ms tick in order to fire active timers if they are expired.
static uint32_t	getTickCountMs ()
	Returns the tick count in milliseconds elapsed since system start.
static bool	getIsRunningState (TimerHandle const timerToCheck)
	Returns if the timer is running.

Static Public Attributes
static constexpr TimerHandle	TIMERHANDLE_INVALID {0}
	Constant which represents an invalid timer handle.

Detailed Description

RuntimeTimer defines the basic Application Interface (API) to the timer part of the run to completion (RTC) kernel.

Timer events are dispatched by the runtime in the same manner as any other event via the executable callback.

Definition at line 52 of file RuntimeTimer.h.

Member Typedef Documentation

TimerHandle

using imt::base::dff::runtime::RuntimeTimer::TimerHandle = int16_t

A TimerHandle is used to identify a timer with a unique number.

Invalid timers have the identifier TIMERHANDLE_INVALID. periodic timer identifiers have a range from 1..INT16_MAX, whereas one-shot timer identifiers have a range from -1..INT16_MIN

Definition at line 61 of file RuntimeTimer.h.

Member Function Documentation

getIsRunningState()

static bool imt::base::dff::runtime::RuntimeTimer::getIsRunningState ( TimerHandle const  timerToCheck )

static

Returns if the timer is running.

Parameters

timerToCheck

Handle of the timer to check.

Returns

bool state of the timer

getTickCountMs()

static uint32_t imt::base::dff::runtime::RuntimeTimer::getTickCountMs ( )

static

Returns the tick count in milliseconds elapsed since system start.

Returns

Tick count in milliseconds.

initTimerModule()

static void imt::base::dff::runtime::RuntimeTimer::initTimerModule ( uint32_t  initialTimeMs = 0 )

static

Initialize software timer module.

Parameters

initialTimeMs

The initial time the timer module uses. This parameter is only used for testing purposes.

killTimer()

static TimerHandle imt::base::dff::runtime::RuntimeTimer::killTimer ( TimerHandle  timerToKill )

static

Kill an existing timer.

In case the timer is not active anymore, the timerHandle will be set to invalid.

Parameters

timerToKill

Handle of the timer to kill.

process1msTick()

static void imt::base::dff::runtime::RuntimeTimer::process1msTick ( )

static

Process the 1ms tick in order to fire active timers if they are expired.

This function is usually called by the hardware specific implementation of the runtime.

startOneShotTimer()

static TimerHandle imt::base::dff::runtime::RuntimeTimer::startOneShotTimer ( RuntimeCore::CoreHandle const  apHandle, TimerHandle  timerToStart, uint32_t const  timerTicksMs  )

static

Starts or restarts the given one shot timer.

In case of invalid parameters, timerToStart is set to an invalid time handle.

Parameters

apHandle	Receiving activeObject.
timerToStart	Handle of the timer to start.
timerTicksMs	Timer delay in milliseconds.

startPeriodicTimer()

static TimerHandle imt::base::dff::runtime::RuntimeTimer::startPeriodicTimer ( RuntimeCore::CoreHandle const  apHandle, TimerHandle  timerToStart, uint32_t const  intervalMs  )

static

Starts a periodic timer.

In case of invalid parameters, an invalid time handle is returned.

Parameters

apHandle	Receiving activeObject.
timerToStart	Handle of the timer to start.
intervalMs	Timer interval in milliseconds (has to be > 0).

updatePeriodicTimer()

static TimerHandle imt::base::dff::runtime::RuntimeTimer::updatePeriodicTimer ( TimerHandle  timerToUpdate, uint32_t const  intervalMs  )

static

Update the intervalMs of an active periodic timer.

Parameters

timerToUpdate	Handle of the Timer to start.
intervalMs	Timer interval in milliseconds.

Member Data Documentation

TIMERHANDLE_INVALID

constexpr TimerHandle imt::base::dff::runtime::RuntimeTimer::TIMERHANDLE_INVALID {0}

staticconstexpr

Constant which represents an invalid timer handle.

Definition at line 66 of file RuntimeTimer.h.

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/RuntimeTimer.h