.. index:: pair: class; grpc_engine_script::GrpcEngineScript
.. _doxid-classgrpc__engine__script_1_1_grpc_engine_script:

class grpc_engine_script::GrpcEngineScript
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	class GrpcEngineScript {
	public:
		// methods
	
		None :ref:`__init__<doxid-classgrpc__engine__script_1_1_grpc_engine_script_1aee55cedb4a87e510aef6efe87d1afed9>`(self self);
		None :ref:`initialize<doxid-classgrpc__engine__script_1_1_grpc_engine_script_1ac4fe0aa591573df63a873f321502b271>`(self self);
		None :ref:`runLoop<doxid-classgrpc__engine__script_1_1_grpc_engine_script_1a37cf9aef6e7897529493a7a272b334e3>`(self self, int timestep_ns);
		None :ref:`shutdown<doxid-classgrpc__engine__script_1_1_grpc_engine_script_1a1294bafbd6cec90427fca419b30aa5cf>`(self self);
		None :ref:`reset<doxid-classgrpc__engine__script_1_1_grpc_engine_script_1a186419460356351ba1ddd481c9c6c1ed>`(self self);
	};
.. _details-classgrpc__engine__script_1_1_grpc_engine_script:

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



Methods
-------

.. index:: pair: function; __init__
.. _doxid-classgrpc__engine__script_1_1_grpc_engine_script_1aee55cedb4a87e510aef6efe87d1afed9:

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

	None __init__(self self)

.. code-block:: cpp

	Constructor

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

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

	None initialize(self self)

.. code-block:: cpp

	Initializes the simulation.
	
	This function should be overwritten by the derived class and
	should contain all steps necessary to initialize the simulation.

.. index:: pair: function; runLoop
.. _doxid-classgrpc__engine__script_1_1_grpc_engine_script_1a37cf9aef6e7897529493a7a272b334e3:

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

	None runLoop(self self, int timestep_ns)

.. code-block:: cpp

	Runs a single step of the simulation.
	
	This function should be overwritten by the derived class and
	should contain all steps necessary to advance the simulation
	by the specified time.

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

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

	None shutdown(self self)

.. code-block:: cpp

	Shutdowns the simulation.
	
	This function should be overwritten by the derived class and
	should contain all steps necessary to cleanly shutdown the simulation.

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

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

	None reset(self self)

.. code-block:: cpp

	Resets the simulation.
	
	This function should be overwritten by the derived class and
	should contain all steps necessary to reset the simulation.