$darkmode
cloe::SimulationConf Struct Reference

#include <stack.hpp>

Inheritance diagram for cloe::SimulationConf:
Collaboration diagram for cloe::SimulationConf:

Public Member Functions

 CONFABLE_SCHEMA (SimulationConf)
 
- Public Member Functions inherited from fable::Confable
 Confable (const Confable &) noexcept
 
 Confable (Confable &&) noexcept=default
 
Confableoperator= (const Confable &other) noexcept
 
Confableoperator= (Confable &&other) noexcept
 
virtual void reset_schema ()
 
Schemaschema ()
 
const Schemaschema () const
 
virtual void validate_or_throw (const Conf &c) const
 
virtual bool validate (const Conf &c, std::optional< SchemaError > &err) const
 
virtual void from_conf (const Conf &c)
 
virtual void to_json (Json &j) const
 
Json to_json () const
 

Public Attributes

std::optional< std::string > name {}
 
Duration model_step_width = Duration{20'000'000}
 
int64_t controller_retry_limit {1000}
 
std::chrono::milliseconds controller_retry_sleep {1}
 
bool abort_on_controller_failure {true}
 

Additional Inherited Members

- Protected Member Functions inherited from fable::Confable
virtual Schema schema_impl ()
 

Detailed Description

The SimulationConf struct contains all configuration values for the simulation itself.

Member Data Documentation

◆ abort_on_controller_failure

bool cloe::SimulationConf::abort_on_controller_failure {true}

Whether to abort on controller failure.

If this is set to false, then the controller is just removed from the set of active controllers as opposed to the entire simulation shutdown.

◆ controller_retry_limit

int64_t cloe::SimulationConf::controller_retry_limit {1000}

How many times we want to retry a controller before aborting.

If this value is negative, then we retry an infinite number of times.

◆ controller_retry_sleep

std::chrono::milliseconds cloe::SimulationConf::controller_retry_sleep {1}

The number of milliseconds to sleep before retrying a controller.

◆ model_step_width

Duration cloe::SimulationConf::model_step_width = Duration{20'000'000}

Nominal model time step.

◆ name

std::optional<std::string> cloe::SimulationConf::name {}

Optional namespace for simulation events and actions.


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