Goby3  3.1.5a
2024.05.23
goby::time::SimulatorSettings Struct Reference

Parameters for enabling and configuring simulation time. More...

#include <goby/time/simulation.h>

Static Public Attributes

static bool using_sim_time
 Enables simulation time if true (if false, none of the remaining parameters are used) More...
 
static int warp_factor
 Warp factor to speed up (or slow time) the time values returned by SteadyClock::now() and SystemClock::now(). For example, to double the speed of the clocks, set this value to 2. More...
 
static std::chrono::system_clock::time_point reference_time
 Reference time when calculating SystemClock::now(). If this is unset, the default is 1 January of the current year. More...
 

Detailed Description

Parameters for enabling and configuring simulation time.

Definition at line 35 of file simulation.h.

Member Data Documentation

◆ reference_time

std::chrono::system_clock::time_point goby::time::SimulatorSettings::reference_time
static

Reference time when calculating SystemClock::now(). If this is unset, the default is 1 January of the current year.

Definition at line 42 of file simulation.h.

◆ using_sim_time

bool goby::time::SimulatorSettings::using_sim_time
static

Enables simulation time if true (if false, none of the remaining parameters are used)

Definition at line 38 of file simulation.h.

◆ warp_factor

int goby::time::SimulatorSettings::warp_factor
static

Warp factor to speed up (or slow time) the time values returned by SteadyClock::now() and SystemClock::now(). For example, to double the speed of the clocks, set this value to 2.

Definition at line 40 of file simulation.h.


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