.. index:: pair: class; engine_script::EngineScript
.. _doxid-classengine__script_1_1_engine_script:

class engine_script::EngineScript
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	class EngineScript {
	public:
		// methods
	
		None :ref:`__init__<doxid-classengine__script_1_1_engine_script_1a3680e475fb37303ebc825a30768b22d6>`(self self);
		None :ref:`initialize<doxid-classengine__script_1_1_engine_script_1a196f1138288d0c42e9e20bb76f6f2b5e>`(self self);
		None :ref:`runLoop<doxid-classengine__script_1_1_engine_script_1aa1b9be9ae920e1e6d47c8ea37a9be2ec>`(self self, int timestep_ns);
		None :ref:`shutdown<doxid-classengine__script_1_1_engine_script_1a2a801974a64ee3fd95e2915460338070>`(self self);
		None :ref:`reset<doxid-classengine__script_1_1_engine_script_1a70f0fa6834d2a06c92d3138b20e7f589>`(self self);
	};
.. _details-classengine__script_1_1_engine_script:

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



Methods
-------

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

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

	None __init__(self self)

.. code-block:: cpp

	Constructor

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

.. 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-classengine__script_1_1_engine_script_1aa1b9be9ae920e1e6d47c8ea37a9be2ec:

.. 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-classengine__script_1_1_engine_script_1a2a801974a64ee3fd95e2915460338070:

.. 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 clearly shutdown the simulation.

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

.. 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.