.. index:: pair: class; SimulationManager
.. _doxid-class_simulation_manager:

class SimulationManager
=======================

.. toctree::
	:hidden:

	enum_SimulationManager_SimState.rst
	struct_SimulationManager_RequestResult.rst

Overview
~~~~~~~~

Manages simulation execution. :ref:`More...<details-class_simulation_manager>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <simulation_manager.h>
	
	class SimulationManager: public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// enums
	
		enum :ref:`SimState<doxid-class_simulation_manager_1ab6eb03ab6461a830e7587d29a4779332>`;

		// structs
	
		struct :ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>`;

		// construction
	
		:ref:`SimulationManager<doxid-class_simulation_manager_1af976d90860cfe9be1ebcc3a9423b3ddd>`(const :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& simulationConfig);
		:target:`SimulationManager<doxid-class_simulation_manager_1a4815a4de0ee28fcce04521a17e95844c>`();

		// methods
	
		static void :ref:`validateConfig<doxid-class_simulation_manager_1a72682b7fff56a816b33a61331428af37>`(:ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& config);
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`initializeSimulation<doxid-class_simulation_manager_1a00bfc0314728a354260d2e199f1b140d>`();
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`resetSimulation<doxid-class_simulation_manager_1a1b2b12f20b3e39a4b353766c618937e5>`();
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`stopSimulation<doxid-class_simulation_manager_1aeac325c71030527f32af9ade03b4697f>`();
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`runSimulationUntilDoneOrTimeout<doxid-class_simulation_manager_1a5ed7bff8c1621af257f5570f162848ab>`();
		virtual bool :target:`hasSimulationTimedOut<doxid-class_simulation_manager_1ab30629c82377f9d5919f89cd53392392>`() const = 0;
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`runSimulation<doxid-class_simulation_manager_1a2671f82d0edf322ba5d1afc5aaa16cc8>`(unsigned numIterations);
		:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` :ref:`shutdownSimulation<doxid-class_simulation_manager_1ad564a7a9be8b21c75805045c704d3ff2>`();
		:ref:`SimState<doxid-class_simulation_manager_1ab6eb03ab6461a830e7587d29a4779332>` :ref:`currentState<doxid-class_simulation_manager_1ab073abd3774190585610e2d4913ee109>`();
		std::string :ref:`printSimState<doxid-class_simulation_manager_1a58dc227aa53374bb998df2c5d08776ba>`(const :ref:`SimState<doxid-class_simulation_manager_1ab6eb03ab6461a830e7587d29a4779332>`& simState);
		:ref:`SimulationDataManager<doxid-class_simulation_data_manager>`& :target:`getSimulationDataManager<doxid-class_simulation_manager_1a54e3cfb3f08f51c07308244da36dc46d>`();
	};

	// direct descendants

	class :ref:`EventLoopSimManager<doxid-class_event_loop_sim_manager>`;
	class :ref:`FTILoopSimManager<doxid-class_f_t_i_loop_sim_manager>`;

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// typedefs
	
		typedef std::shared_ptr<T> :ref:`shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`;
		typedef std::shared_ptr<const T> :ref:`const_shared_ptr<doxid-class_ptr_templates_1ac36bfa374f3b63c85ba97d8cf953ce3b>`;
		typedef std::unique_ptr<T> :ref:`unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>`;
		typedef std::unique_ptr<const T> :ref:`const_unique_ptr<doxid-class_ptr_templates_1aef0eb44f9c386dbf0de54d0f5afac667>`;

.. _details-class_simulation_manager:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Manages simulation execution.

Maintain the current state of the simulation and process control requests according to this state.

Control request methods are processed sequentially guarded by a lock, with the exception of "stopSimulation", which can be processed in parallel.

Control requests are forwarded to Implementations of this interface via a set of callbacks. Exceptions occurring in these callbacks are handled by :ref:`SimulationManager <doxid-class_simulation_manager>` by transitioning the simulation to state "Failed", from which the only possible action is to shutdown the simulation.

Calling a control request from the wrong state triggers an exception

Construction
------------

.. index:: pair: function; SimulationManager
.. _doxid-class_simulation_manager_1af976d90860cfe9be1ebcc3a9423b3ddd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	SimulationManager(const :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& simulationConfig)

Constructor.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- simulationConfig

		- Simulation configuration

Methods
-------

.. index:: pair: function; validateConfig
.. _doxid-class_simulation_manager_1a72682b7fff56a816b33a61331428af37:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static void validateConfig(:ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& config)

Validates config against Simulation schema.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- config

		- Pointer to a config

.. index:: pair: function; initializeSimulation
.. _doxid-class_simulation_manager_1a00bfc0314728a354260d2e199f1b140d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` initializeSimulation()

Initialize the simulation.



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; resetSimulation
.. _doxid-class_simulation_manager_1a1b2b12f20b3e39a4b353766c618937e5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` resetSimulation()

Reset the currently running simulation.



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; stopSimulation
.. _doxid-class_simulation_manager_1aeac325c71030527f32af9ade03b4697f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` stopSimulation()

Request to stop the simulation if it was running, if it wasn't the call has no effect.

It is not blocking, i.e. it is not guaranteed that the simulation is in state "Stopped" after the call returns. The simulation will stop after the the "runSimulation" request that started it returns.



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; runSimulationUntilDoneOrTimeout
.. _doxid-class_simulation_manager_1a5ed7bff8c1621af257f5570f162848ab:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` runSimulationUntilDoneOrTimeout()

Runs the simulation until a separate thread stops it or simTimeout (defined in SimulationConfig) is reached. If simTimeout is zero or negative, ignore it.



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; runSimulation
.. _doxid-class_simulation_manager_1a2671f82d0edf322ba5d1afc5aaa16cc8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` runSimulation(unsigned numIterations)

Run the Simulation for specified amount of timesteps.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- numIterations

		- Number of iterations (i.e timesteps) to run simulation



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; shutdownSimulation
.. _doxid-class_simulation_manager_1ad564a7a9be8b21c75805045c704d3ff2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`RequestResult<doxid-struct_simulation_manager_1_1_request_result>` shutdownSimulation()

Shuts down the simulation.



.. rubric:: Returns:

Simulation state after processing the request

.. index:: pair: function; currentState
.. _doxid-class_simulation_manager_1ab073abd3774190585610e2d4913ee109:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`SimState<doxid-class_simulation_manager_1ab6eb03ab6461a830e7587d29a4779332>` currentState()

returns the current state of the simulation

.. index:: pair: function; printSimState
.. _doxid-class_simulation_manager_1a58dc227aa53374bb998df2c5d08776ba:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string printSimState(const :ref:`SimState<doxid-class_simulation_manager_1ab6eb03ab6461a830e7587d29a4779332>`& simState)

returns a simulation state as a string