Dataflow Runtime API  3.1.1.0
Static Public Member Functions | List of all members
imt::base::dff::runtime::FreeRunningTimer Class Reference

Representation of a free running timer module in ticks, which keeps repeatedly running. More...

#include <Imt.Base.Dff.Runtime/FreeRunningTimer.h>

Static Public Member Functions

static void initFreeRunningTimer (void)
 Initialize the system time. More...
 
static uint32_t microSecondsToTicks (const uint32_t microSeconds)
 Converts a time value in micro second resolution to a time value in tick resolution. More...
 
static uint32_t ticksToMicroSeconds (const uint32_t ticks)
 Converts a time value in tick resolution to a time value in micro seconds resolution. More...
 
static uint32_t getTicks (void)
 Get the current time. More...
 

Detailed Description

Representation of a free running timer module in ticks, which keeps repeatedly running.

The resolution of a tick is platform dependent, but is usually higher than the regular 1ms timer tick of RuntimeTimer. During link time this interface will be statically linked to a platform dependent implementation.

Member Function Documentation

◆ getTicks()

static uint32_t imt::base::dff::runtime::FreeRunningTimer::getTicks ( void  )
static

Get the current time.

Returns
the current time since start in ticks

◆ initFreeRunningTimer()

static void imt::base::dff::runtime::FreeRunningTimer::initFreeRunningTimer ( void  )
static

Initialize the system time.

◆ microSecondsToTicks()

static uint32_t imt::base::dff::runtime::FreeRunningTimer::microSecondsToTicks ( const uint32_t  microSeconds)
static

Converts a time value in micro second resolution to a time value in tick resolution.

Parameters
microSecondsValue in micro second resolution.
Returns
Number of ticks that represents the provided number of micro seconds.

◆ ticksToMicroSeconds()

static uint32_t imt::base::dff::runtime::FreeRunningTimer::ticksToMicroSeconds ( const uint32_t  ticks)
static

Converts a time value in tick resolution to a time value in micro seconds resolution.

Parameters
ticksValue in tick resolution.
Returns
Number of micro seconds that represents the provided number of ticks.

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