Simulation Stats

This module contains the definition of the SimulationStats dataclass.

Example

Creating a simulation stat:

stat = SimulationStats(time=1, stop_time=3, frequency=Time(0.5), False)
class gsf.control.core.simulation_stats.SimulationStats(time: decimal.Decimal, stop_time: decimal.Decimal, frequency: decimal.Decimal, is_paused: bool)

Bases: object

time

current time of the simulation.

Type

Time

stop_time

time when the simulation will stop.

Type

Time

frequency

frequency of the simulation step.

Type

Time

is_paused

bool that indicates if the simulation is running.

Type

bool

frequency: decimal.Decimal
is_paused: bool
stop_time: decimal.Decimal
time: decimal.Decimal