.. index:: pair: class; SimManager::SimulatorManager
.. _doxid-class_sim_manager_1_1_simulator_manager:

class SimManager::SimulatorManager
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

.. :ref:`More...<details-class_sim_manager_1_1_simulator_manager>`


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

	
	class SimulatorManager: public object {
	public:
		// fields
	
		 :target:`time_step<doxid-class_sim_manager_1_1_simulator_manager_1a6dd364659d201dca9b9bb334198f9214>`;
		 :target:`sim_interface<doxid-class_sim_manager_1_1_simulator_manager_1a25529d717170f0ceaca20fec53d08457>`;

		// methods
	
		def :target:`__init__<doxid-class_sim_manager_1_1_simulator_manager_1a57c9be5199248bcac2c1f8acbc4ec3f5>`(self self, configuration configuration);
		def :ref:`reset<doxid-class_sim_manager_1_1_simulator_manager_1af998880c45993a46f9a72923c5a6b507>`(self self);
		def :ref:`shutdown<doxid-class_sim_manager_1_1_simulator_manager_1aa5b1b9cb0f06f0936649811969cb14ad>`(self self);
		def :ref:`run_step<doxid-class_sim_manager_1_1_simulator_manager_1a2e5bccabbda66d3ada291d1062335de2>`(self self, action action, timestep_ns timestep_ns);
		def :ref:`get_model_properties<doxid-class_sim_manager_1_1_simulator_manager_1a70fa260e1789bdb8706fc5d73699af7d>`(self self, datapack_type datapack_type);
		def :ref:`get_model_all_properties<doxid-class_sim_manager_1_1_simulator_manager_1aa854e9ef93f2d9c487b3ff2fac1aaf3f>`(self self, datapack_type datapack_type);
	
		def :ref:`get_model_property<doxid-class_sim_manager_1_1_simulator_manager_1ab038bd84677216248d180c3152dad253>`(
			self self,
			datapack_name datapack_name,
			datapack_type datapack_type
		);
	
		def :target:`get_sim_time<doxid-class_sim_manager_1_1_simulator_manager_1a9360112d779d8b10e7121e7e9837107b>`(self self);
	};
.. _details-class_sim_manager_1_1_simulator_manager:

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

.. code-block:: cpp

	This class receives the information that a simulator needs from an EngineScript,
	and it then starts and manages a simulator via its Python API.

Methods
-------

.. index:: pair: function; reset
.. _doxid-class_sim_manager_1_1_simulator_manager_1af998880c45993a46f9a72923c5a6b507:

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

	def reset(self self)

.. code-block:: cpp

	Reset the simulation, it is connected by the "server_callbacks.py"

.. index:: pair: function; shutdown
.. _doxid-class_sim_manager_1_1_simulator_manager_1aa5b1b9cb0f06f0936649811969cb14ad:

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

	def shutdown(self self)

.. code-block:: cpp

	Shutdown the simulation, it is connected by the "server_callbacks.py"

.. index:: pair: function; run_step
.. _doxid-class_sim_manager_1_1_simulator_manager_1a2e5bccabbda66d3ada291d1062335de2:

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

	def run_step(self self, action action, timestep_ns timestep_ns)

.. code-block:: cpp

	Obtain parameters from the engine script and run the simulation step by step
	
	:param action: the control parameters for the simulation
	:type action: list
	:param timestep_ns: time step length of the simulation (nanosecs)
	:type timestep_ns: int

.. index:: pair: function; get_model_properties
.. _doxid-class_sim_manager_1_1_simulator_manager_1a70fa260e1789bdb8706fc5d73699af7d:

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

	def get_model_properties(self self, datapack_type datapack_type)

.. code-block:: cpp

	Obtain devices list
	
	:param datapack_type: data type of the required device
	:type datapack_type: str

.. index:: pair: function; get_model_all_properties
.. _doxid-class_sim_manager_1_1_simulator_manager_1aa854e9ef93f2d9c487b3ff2fac1aaf3f:

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

	def get_model_all_properties(self self, datapack_type datapack_type)

.. code-block:: cpp

	Obtain all devices data of a special type
	
	:param datapack_type:  (string): data type of required devices
	:type datapack_type: str

.. index:: pair: function; get_model_property
.. _doxid-class_sim_manager_1_1_simulator_manager_1ab038bd84677216248d180c3152dad253:

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

	def get_model_property(
		self self,
		datapack_name datapack_name,
		datapack_type datapack_type
	)

.. code-block:: cpp

	Obtain data of a device based on its name
	
	:param datapack_name: name of the required device
	:type datapack_type: str
	:param datapack_type: data type of the required device
	:type datapack_type: str