coral
A C++ library for distributed co-simulation
Public Attributes | List of all members
coral::master::ExecutionOptions Struct Reference

Configuration options for an execution. More...

#include "coral/master/execution_options.hpp"

Public Attributes

coral::model::TimePoint startTime = 0.0
 The start time of the simulation. More...
 
coral::model::TimePoint maxTime = coral::model::ETERNITY
 The maximum simulation time point. More...
 
std::chrono::milliseconds slaveVariableRecvTimeout = std::chrono::seconds(1)
 Timeout used by the slaves to detect loss of communication with other slaves. More...
 

Detailed Description

Configuration options for an execution.

An object of this type may be passed to Execution::Execution().

Member Data Documentation

coral::model::TimePoint coral::master::ExecutionOptions::maxTime = coral::model::ETERNITY

The maximum simulation time point.

This may be coral::model::ETERNITY (the default), signifying that there is no predefined maximum time. Otherwise, it must be greater than startTime.

This is currently not used by Coral itself, but may be used by some slaves, e.g. to pre-allocate resources such as memory.

std::chrono::milliseconds coral::master::ExecutionOptions::slaveVariableRecvTimeout = std::chrono::seconds(1)

Timeout used by the slaves to detect loss of communication with other slaves.

This is used when slaves exchange variable values among themselves. A negative value means no timeout.

coral::model::TimePoint coral::master::ExecutionOptions::startTime = 0.0

The start time of the simulation.

This must be less than maxTime.


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