.. index:: pair: class; TFManagerHandle
.. _doxid-class_t_f_manager_handle:

class TFManagerHandle
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Uses the TF framework to execute datapack transformation operations. :ref:`More...<details-class_t_f_manager_handle>`


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

	#include <tf_manager_handle.h>
	
	class TFManagerHandle: public :ref:`DataPackProcessor<doxid-class_data_pack_processor>` {
	public:
		// construction
	
		:target:`TFManagerHandle<doxid-class_t_f_manager_handle_1a3987bc02f4c21b782fecb01b5112d850>`(:ref:`SimulationDataManager<doxid-class_simulation_data_manager>`* simulationDataManager);

		// methods
	
		virtual void :ref:`init<doxid-class_t_f_manager_handle_1a2443878d8b6c10c01c6198fa370a28f6>`(
			const :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& simConfig,
			const :ref:`engine_interfaces_t<doxid-class_data_pack_processor_1a269b18f42f5acedb594ad2912c795824>`& engines
		);
	
		virtual void :ref:`postEngineInit<doxid-class_t_f_manager_handle_1a0a94e8039ad43eec205f930dbfbc51bf>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		virtual void :ref:`preEngineReset<doxid-class_t_f_manager_handle_1a5b906eb4711e6360e890be84965c2cbd>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		virtual void :ref:`postEngineReset<doxid-class_t_f_manager_handle_1a88dd69f03db276c9c19087391b9347fb>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		virtual void :ref:`updateDataPacksFromEngines<doxid-class_t_f_manager_handle_1a74342bbae9037dd9284f631fcafe26cb>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		virtual void :ref:`compute<doxid-class_t_f_manager_handle_1afffb376ad5e96c8cac127a52e13182aa>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		virtual void :ref:`sendDataPacksToEngines<doxid-class_t_f_manager_handle_1a6e9bc567ab328f0071445d3baf387cbc>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
	};

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

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

	public:
		// typedefs
	
		typedef std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`> :ref:`engine_interfaces_t<doxid-class_data_pack_processor_1a269b18f42f5acedb594ad2912c795824>`;

		// methods
	
		virtual void :ref:`init<doxid-class_data_pack_processor_1a85eace47761c625f2526e6f0efb51c83>`(
			const :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& simConfig,
			const :ref:`engine_interfaces_t<doxid-class_data_pack_processor_1a269b18f42f5acedb594ad2912c795824>`& engines
		) = 0;
	
		virtual void :ref:`updateDataPacksFromEngines<doxid-class_data_pack_processor_1a24a4cf8e245dd8526f3b451dcb78cefd>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines) = 0;
		virtual void :ref:`compute<doxid-class_data_pack_processor_1a89859a99d685bf7a495b8c3a1e644717>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines) = 0;
		virtual void :ref:`sendDataPacksToEngines<doxid-class_data_pack_processor_1ad980b1d73a944d8b3c6faf3777b9b488>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines) = 0;
		virtual void :ref:`postEngineInit<doxid-class_data_pack_processor_1a625e0d148919bfdc236cd95666817955>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>&);
		virtual void :ref:`preEngineReset<doxid-class_data_pack_processor_1a3c321bd55b319c53315743eb6535cbb0>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>&);
		virtual void :ref:`postEngineReset<doxid-class_data_pack_processor_1af3a9acad49537cf72d35eb021b270be4>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>&);
		void :ref:`datapackCycle<doxid-class_data_pack_processor_1a63fa2e4c1c411be5a2b2c58ad8507c4e>`(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines);
		void :ref:`setSimulationTime<doxid-class_data_pack_processor_1ac720f436a486e17def900cd9907b89ce>`(:ref:`SimulationTime<doxid-time__utils_8h_1aadff625b29e39dc2d75a7d476d5040c1>` simulationTime);
		void :ref:`setSimulationIteration<doxid-class_data_pack_processor_1ad6cae511fe492252a88947d560d62b93>`(unsigned long simulationIteration);

.. _details-class_t_f_manager_handle:

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

Uses the TF framework to execute datapack transformation operations.

Methods
-------

.. index:: pair: function; init
.. _doxid-class_t_f_manager_handle_1a2443878d8b6c10c01c6198fa370a28f6:

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

	virtual void init(
		const :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>`& simConfig,
		const :ref:`engine_interfaces_t<doxid-class_data_pack_processor_1a269b18f42f5acedb594ad2912c795824>`& engines
	)

Initializes the handler.



.. rubric:: Parameters:

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

	*
		- simConfig

		- json object containing configuration information to initialize the handler

	*
		- engines

		- list of Engine clients participating in the simulation

.. index:: pair: function; postEngineInit
.. _doxid-class_t_f_manager_handle_1a0a94e8039ad43eec205f930dbfbc51bf:

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

	virtual void postEngineInit(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Performs post-engine-initialization :ref:`DataPack <doxid-class_data_pack>` operations.

The method will retrieve DataPacks prepared by the engines' :ref:`initialize() <doxid-namespacepython__json__engine_1a6c79e6ba0653aa9eadb8cff8a0d0588d>` functions, and push them into the trajectory buffer, so that they can be returned to the main script.



.. rubric:: Parameters:

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

	*
		- engines

		- Vector of engines for which the post-init step should be performed

.. index:: pair: function; preEngineReset
.. _doxid-class_t_f_manager_handle_1a5b906eb4711e6360e890be84965c2cbd:

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

	virtual void preEngineReset(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Performs pre-engine-reset :ref:`DataPack <doxid-class_data_pack>` operations.

The method will send Engine DataPacks to all engines. This allows the main script to send additional data or commands to the engines on :ref:`reset() <doxid-namespacepython__json__engine_1a73c8356ee4133ade577c1ea9772f6ed7>`.



.. rubric:: Parameters:

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

	*
		- engines

		- Vector of engines for which the pre-init step should be performed

.. index:: pair: function; postEngineReset
.. _doxid-class_t_f_manager_handle_1a88dd69f03db276c9c19087391b9347fb:

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

	virtual void postEngineReset(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Performs post-engine-reset :ref:`DataPack <doxid-class_data_pack>` operations.

The method will retrieve DataPacks prepared by the engines' :ref:`reset() <doxid-namespacepython__json__engine_1a73c8356ee4133ade577c1ea9772f6ed7>` functions, and push them into the trajectory buffer, so that they can be returned to the main script.



.. rubric:: Parameters:

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

	*
		- engines

		- Vector of engines for which the post-reset step should be performed

.. index:: pair: function; updateDataPacksFromEngines
.. _doxid-class_t_f_manager_handle_1a74342bbae9037dd9284f631fcafe26cb:

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

	virtual void updateDataPacksFromEngines(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Request datapacks from engines.



.. rubric:: Parameters:

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

	*
		- engines

		- Engines that are been synchronize in the current loop

.. index:: pair: function; compute
.. _doxid-class_t_f_manager_handle_1afffb376ad5e96c8cac127a52e13182aa:

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

	virtual void compute(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Perform computations on datapacks.



.. rubric:: Parameters:

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

	*
		- engines

		- Engines that are been synchronize in the current loop

.. index:: pair: function; sendDataPacksToEngines
.. _doxid-class_t_f_manager_handle_1a6e9bc567ab328f0071445d3baf387cbc:

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

	virtual void sendDataPacksToEngines(const std::vector<:ref:`EngineClientInterfaceSharedPtr<doxid-engine__client__interface_8h_1ac903cea490b8ce188463593e5b5621b3>`>& engines)

Send datapacks to engines.



.. rubric:: Parameters:

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

	*
		- engines

		- Engines that are been synchronize in the current loop