Struct emulator::OutputControl

ClassList > emulator > OutputControl

Controls output timing and tracks averaging state.

• #include <emulator_output_stream.hpp>

Public Attributes

Type	Name
int	current_step = 0
double	dt = 0.0
int	frequency = 1
FrequencyUnit	frequency_unit = FrequencyUnit::NDAYS
int	last_write_step = -1
int	next_write_step = 0
int	nsamples_since_last_write = 0

Public Functions

Type	Name
void	compute_next_write_step (int current_step, double dt) Compute next write step from frequency and current step.
bool	is_write_step (int step) const Check if current step is a write step.
bool	output_enabled () const Check if output is enabled.
double	seconds_per_unit () const Get number of seconds per frequency unit.

Public Attributes Documentation

variable current_step

int emulator::OutputControl::current_step;

---

variable dt

double emulator::OutputControl::dt;

---

variable frequency

int emulator::OutputControl::frequency;

---

variable frequency_unit

FrequencyUnit emulator::OutputControl::frequency_unit;

---

variable last_write_step

int emulator::OutputControl::last_write_step;

---

variable next_write_step

int emulator::OutputControl::next_write_step;

---

variable nsamples_since_last_write

int emulator::OutputControl::nsamples_since_last_write;

---

Public Functions Documentation

function compute_next_write_step

Compute next write step from frequency and current step.

void emulator::OutputControl::compute_next_write_step (
    int current_step,
    double dt
) 

---

function is_write_step

Check if current step is a write step.

bool emulator::OutputControl::is_write_step (
    int step
) const

---

function output_enabled

Check if output is enabled.

inline bool emulator::OutputControl::output_enabled () const

---

function seconds_per_unit

Get number of seconds per frequency unit.

double emulator::OutputControl::seconds_per_unit () const

---

---

The documentation for this class was generated from the following file components/emulator_comps/common/src/emulator_output_stream.hpp