Reference¶

This chapter contains reference documentation for various systems in Cloe. It is assumed that you already know how the systems work and what they are there for. See the chapters Overview and Usage Guides if you need more background knowledge for any of the following topics.

Doxygen: provides C++ API documentation generated by Doxygen.
System States: provides an overview of the structure of a simulation loop.
Model States: provides an overview of when the various methods of a simulation model are executed.
Stack Configuration: provides an overview of all the different parameters that can be written in a Cloe stack file. These configure the runtime and the orchestration of a simulation.
Hook Execution: provides an explanation of how to use pre-connect and post-disconnect hooks.
Variable Interpolation: provides an explanation of variable interpolation in input stack files.
Runtime Watchdog: provides a detailed explanation of the watchdog feature of the Cloe runtime.
JSON API: provides an overview of all endpoints that are made available from the Cloe runtime. These can be used to build interfaces to Cloe or utility tools for simulations.
Triggers: provides an overview of how to use triggers with Cloe.
Built-in Events: provides an overview of all available trigger events.
Built-in Actions: provides an overview of all available trigger actions.
Plugins: provides an overview of all plugins that are part of the Cloe distribution.
Lua Initialization: provides an overview of how the engine processes a Lua file.