HardFOC Core
API reference
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | List of all members
hf::host::FakeClock Class Reference

#include <FakeClock.h>

Static Public Member Functions

static uint64_t NowUs () noexcept
 Current time in microseconds (does not auto-advance).
 
static void AdvanceUs (uint64_t us) noexcept
 Move time forward by us microseconds.
 
static void AdvanceMs (uint64_t ms) noexcept
 Move time forward by ms milliseconds.
 
static void SetAutoAdvanceUs (uint64_t us) noexcept
 Time added on every clock read from code under test.
 
static uint64_t AutoAdvanceUs () noexcept
 
static uint64_t TotalDelayUs () noexcept
 Sum of all delays requested by code under test, in microseconds.
 
static uint64_t DelayCount () noexcept
 Number of delay calls made by code under test.
 
static void Reset () noexcept
 Time back to 0, counters cleared, auto-advance back to default.
 

Static Public Attributes

static constexpr uint64_t kDefaultAutoAdvanceUs = 10U
 

Member Function Documentation

◆ AdvanceMs()

static void hf::host::FakeClock::AdvanceMs ( uint64_t  ms)
inlinestaticnoexcept

Move time forward by ms milliseconds.

◆ AdvanceUs()

void hf::host::FakeClock::AdvanceUs ( uint64_t  us)
staticnoexcept

Move time forward by us microseconds.

◆ AutoAdvanceUs()

uint64_t hf::host::FakeClock::AutoAdvanceUs ( )
staticnoexcept

◆ DelayCount()

uint64_t hf::host::FakeClock::DelayCount ( )
staticnoexcept

Number of delay calls made by code under test.

◆ NowUs()

uint64_t hf::host::FakeClock::NowUs ( )
staticnoexcept

Current time in microseconds (does not auto-advance).

◆ Reset()

void hf::host::FakeClock::Reset ( )
staticnoexcept

Time back to 0, counters cleared, auto-advance back to default.

◆ SetAutoAdvanceUs()

void hf::host::FakeClock::SetAutoAdvanceUs ( uint64_t  us)
staticnoexcept

Time added on every clock read from code under test.

◆ TotalDelayUs()

uint64_t hf::host::FakeClock::TotalDelayUs ( )
staticnoexcept

Sum of all delays requested by code under test, in microseconds.

Member Data Documentation

◆ kDefaultAutoAdvanceUs

constexpr uint64_t hf::host::FakeClock::kDefaultAutoAdvanceUs = 10U
staticconstexpr

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