AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
AJATime Class Reference

Collection of platform-independent host system clock time functions. More...

#include <systemtime.h>

Static Public Member Functions

static int64_t GetSystemTime (void)
 Returns the current value of the host system's low-resolution clock, in milliseconds. More...
 
static int64_t GetSystemCounter (void)
 Returns the current value of the host system's high-resolution time counter. More...
 
static int64_t GetSystemFrequency (void)
 Returns the frequency of the host system's high-resolution time counter. More...
 
static double GetSystemSeconds (void)
 Returns the current value of the host's high-resolution clock, in seconds. More...
 
static uint64_t GetSystemMilliseconds (void)
 Returns the current value of the host's high-resolution clock, in milliseconds. More...
 
static uint64_t GetSystemMicroseconds (void)
 Returns the current value of the host's high-resolution clock, in microseconds. More...
 
static uint64_t GetSystemNanoseconds (void)
 Returns the current value of the host's high-resolution clock, in nanoseconds. More...
 
static void Sleep (const int32_t inMilliseconds)
 Suspends execution of the current thread for a given number of milliseconds. More...
 
static void SleepInMicroseconds (const int32_t inMicroseconds)
 Suspends execution of the current thread for a given number of microseconds. More...
 
static void SleepInNanoseconds (const uint64_t inNanoseconds)
 Suspends execution of the current thread for a given number of nanoseconds. More...
 

Detailed Description

Collection of platform-independent host system clock time functions.

Definition at line 31 of file systemtime.h.

Member Function Documentation

◆ GetSystemCounter()

int64_t AJATime::GetSystemCounter ( void  )
static

Returns the current value of the host system's high-resolution time counter.

Returns
The current value of the host system's high-resolution time counter.

Definition at line 112 of file systemtime.cpp.

◆ GetSystemFrequency()

int64_t AJATime::GetSystemFrequency ( void  )
static

Returns the frequency of the host system's high-resolution time counter.

Returns
The high resolution counter frequency in ticks per second.

Definition at line 149 of file systemtime.cpp.

◆ GetSystemMicroseconds()

uint64_t AJATime::GetSystemMicroseconds ( void  )
static

Returns the current value of the host's high-resolution clock, in microseconds.

Returns
Current value of the host's clock, in microseconds, based on GetSystemCounter() and GetSystemFrequency().

Definition at line 221 of file systemtime.cpp.

◆ GetSystemMilliseconds()

uint64_t AJATime::GetSystemMilliseconds ( void  )
static

Returns the current value of the host's high-resolution clock, in milliseconds.

Returns
Current value of the host's clock, in milliseconds, based on GetSystemCounter() and GetSystemFrequency().

Definition at line 206 of file systemtime.cpp.

◆ GetSystemNanoseconds()

uint64_t AJATime::GetSystemNanoseconds ( void  )
static

Returns the current value of the host's high-resolution clock, in nanoseconds.

Returns
Current value of the host's clock, in nanoseconds, based on GetSystemCounter() and GetSystemFrequency().

Definition at line 236 of file systemtime.cpp.

◆ GetSystemSeconds()

double AJATime::GetSystemSeconds ( void  )
static

Returns the current value of the host's high-resolution clock, in seconds.

Returns
Current value of the host's clock, in seconds, based on GetSystemCounter() and GetSystemFrequency().

Definition at line 193 of file systemtime.cpp.

◆ GetSystemTime()

int64_t AJATime::GetSystemTime ( void  )
static

Returns the current value of the host system's low-resolution clock, in milliseconds.

Returns
The current value of the host system's low-resolution clock, in milliseconds.

Definition at line 74 of file systemtime.cpp.

◆ Sleep()

void AJATime::Sleep ( const int32_t  inMilliseconds)
static

Suspends execution of the current thread for a given number of milliseconds.

Parameters
inMillisecondsSpecifies the sleep time, in milliseconds.

Definition at line 284 of file systemtime.cpp.

◆ SleepInMicroseconds()

void AJATime::SleepInMicroseconds ( const int32_t  inMicroseconds)
static

Suspends execution of the current thread for a given number of microseconds.

Parameters
inMicrosecondsTime to sleep (microseconds).

Definition at line 304 of file systemtime.cpp.

◆ SleepInNanoseconds()

void AJATime::SleepInNanoseconds ( const uint64_t  inNanoseconds)
static

Suspends execution of the current thread for a given number of nanoseconds.

Parameters
inMicrosecondsTime to sleep (nanoseconds).

Definition at line 323 of file systemtime.cpp.


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