.. index:: pair: namespace; grpc_server_callbacks
.. _doxid-namespacegrpc__server__callbacks:

namespace grpc_server_callbacks
===============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	namespace grpc_server_callbacks {

	// global variables

	 :target:`script<doxid-namespacegrpc__server__callbacks_1a547349ff646093957f0bfc6a1c478dc1>` =  None;

	// global functions

	str :ref:`get_engine_name<doxid-namespacegrpc__server__callbacks_1a2850000e5b78b53783f793bc908f0cf0>`();
	dict :ref:`initialize<doxid-namespacegrpc__server__callbacks_1af233e68e1cdb61455647d3f1cb160493>`(dict request_json);
	int :ref:`run_loop<doxid-namespacegrpc__server__callbacks_1a895cfe0462dd10f86a364e14632e5d14>`(int time_step);
	python_grpc_engine_pb2.SetDataPacksReply :ref:`set_datapacks<doxid-namespacegrpc__server__callbacks_1a7bd7f05d621df6171bc54f045fd7ed67>`(python_grpc_engine_pb2.SetDataPacksRequest request_grpc);
	None :ref:`set_datapack<doxid-namespacegrpc__server__callbacks_1ad3f2a6d27c35ff5476d2bcbd87540b83>`(python_grpc_engine_pb2.DataPackMessage datapack);
	list :ref:`get_registered_datapack_names<doxid-namespacegrpc__server__callbacks_1aa1de9deb71528f891323c52a55add8b8>`();
	python_grpc_engine_pb2.GetDataPacksReply :ref:`get_datapacks<doxid-namespacegrpc__server__callbacks_1af19776cd03baeb35c2ad41baeebce101>`(python_grpc_engine_pb2.GetDataPacksRequest request_grpc);
	python_grpc_engine_pb2.DataPackMessage :ref:`get_datapack<doxid-namespacegrpc__server__callbacks_1a6329cd9afaaa8023d11147f9f7b4a64f>`(python_grpc_engine_pb2.DataPackIdentifier datapack_id);
	dict :ref:`reset<doxid-namespacegrpc__server__callbacks_1acf21185ea3e9a4c4e44c4dd08c45bf29>`(dict request_json);
	None :ref:`shutdown<doxid-namespacegrpc__server__callbacks_1a7700d4054c5cfd63dc7207ca8cb08bd9>`(dict request_json);

	} // namespace grpc_server_callbacks
.. _details-namespacegrpc__server__callbacks:

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



Global Functions
----------------

.. index:: pair: function; get_engine_name
.. _doxid-namespacegrpc__server__callbacks_1a2850000e5b78b53783f793bc908f0cf0:

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

	str get_engine_name()

.. code-block:: cpp

	Returns Engine name

.. index:: pair: function; initialize
.. _doxid-namespacegrpc__server__callbacks_1af233e68e1cdb61455647d3f1cb160493:

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

	dict initialize(dict request_json)

.. code-block:: cpp

	Imports module containing the Script class, instantiates it, and runs its initialize() method

.. index:: pair: function; run_loop
.. _doxid-namespacegrpc__server__callbacks_1a895cfe0462dd10f86a364e14632e5d14:

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

	int run_loop(int time_step)

.. code-block:: cpp

	Advances the simulation time and runs the runLoop method of the Script object

.. index:: pair: function; set_datapacks
.. _doxid-namespacegrpc__server__callbacks_1a7bd7f05d621df6171bc54f045fd7ed67:

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

	python_grpc_engine_pb2.SetDataPacksReply set_datapacks(python_grpc_engine_pb2.SetDataPacksRequest request_grpc)

.. code-block:: cpp

	Sets given data on requested datapacks stored in the Script object

.. index:: pair: function; set_datapack
.. _doxid-namespacegrpc__server__callbacks_1ad3f2a6d27c35ff5476d2bcbd87540b83:

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

	None set_datapack(python_grpc_engine_pb2.DataPackMessage datapack)

.. code-block:: cpp

	Set datapack in the Script object

.. index:: pair: function; get_registered_datapack_names
.. _doxid-namespacegrpc__server__callbacks_1aa1de9deb71528f891323c52a55add8b8:

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

	list get_registered_datapack_names()

.. code-block:: cpp

	Returns the list of registered datapack names

.. index:: pair: function; get_datapacks
.. _doxid-namespacegrpc__server__callbacks_1af19776cd03baeb35c2ad41baeebce101:

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

	python_grpc_engine_pb2.GetDataPacksReply get_datapacks(python_grpc_engine_pb2.GetDataPacksRequest request_grpc)

.. code-block:: cpp

	Returns requested datapacks stored in the Script object

.. index:: pair: function; get_datapack
.. _doxid-namespacegrpc__server__callbacks_1a6329cd9afaaa8023d11147f9f7b4a64f:

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

	python_grpc_engine_pb2.DataPackMessage get_datapack(python_grpc_engine_pb2.DataPackIdentifier datapack_id)

.. code-block:: cpp

	Returns requested datapack stored in the Script object

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

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

	dict reset(dict request_json)

.. code-block:: cpp

	Calls the reset() method of the Script object

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

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

	None shutdown(dict request_json)

.. code-block:: cpp

	Calls the shutdown() method of the Script object