SimulationOptions Struct Reference

#include <drake/systems/Simulation.h>

Collaboration diagram for SimulationOptions:

Public Member Functions
	SimulationOptions ()

Public Attributes
double	realtime_factor
double	initial_step_size
double	timeout_seconds
bool	warn_real_time_violation
	This variable dermines what happens if the simulation's timing is delayed by more than timeout_seconds. More...
std::function< bool(double)>	should_stop
	Enables a custom simulation termination condition. More...

Constructor & Destructor Documentation

SimulationOptions ( )

inline

Member Data Documentation

double initial_step_size

double realtime_factor

std::function<bool(double)> should_stop

Enables a custom simulation termination condition.

This function is called each cycle of the simulation loop. The input parameter of type double is the current simulation time. If the function returns true, the simulation is terminated. The default for this is a function that always returns false.

double timeout_seconds

bool warn_real_time_violation

This variable dermines what happens if the simulation's timing is delayed by more than timeout_seconds.

When this occurs, a warning is printed if this variable is true, and an exception is raised if this variable is false.

---

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

• drake/systems/Simulation.h