.. index:: pair: class; TransceiverDataPackInterface
.. _doxid-class_transceiver_data_pack_interface:

class TransceiverDataPackInterface
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Base of TF Decorators. :ref:`More...<details-class_transceiver_data_pack_interface>`


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

	#include <transceiver_datapack_interface.h>
	
	class TransceiverDataPackInterface: public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// methods
	
		template <class TRANSCEIVER_DATAPACK>
		:ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>` :ref:`pySetup<doxid-class_transceiver_data_pack_interface_1ad14f7dc9eb8b8e09e4281fbf20a9583e>`(const :ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`& tfDataPack);
	
		virtual const std::string& :ref:`linkedEngineName<doxid-class_transceiver_data_pack_interface_1a0857c957956587af7a92f981a26ec987>`() const;
		virtual bool :ref:`isPreprocessing<doxid-class_transceiver_data_pack_interface_1a22bbf4eb17c7c35d894b2ffb4bb762c9>`() const;
	
		virtual boost::python::object :ref:`runTf<doxid-class_transceiver_data_pack_interface_1af3e70d106ebadb7d8cf71c48b39a9043>`(
			boost::python::tuple& args,
			boost::python::dict& kwargs,
			:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
		);
	
		virtual :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>` :ref:`updateRequestedDataPackIDs<doxid-class_transceiver_data_pack_interface_1af4e5f51d7def898d42ca74da7311be31>`(:ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>`&& datapackIDs = :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>`()) const;
		virtual :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>` :ref:`getRequestedDataPackIDs<doxid-class_transceiver_data_pack_interface_1a93b17cbf01d3a38938ed50d64aff7ebf>`() const;
		static void :ref:`setTFInterpreter<doxid-class_transceiver_data_pack_interface_1a3626e61d35dadf407ec44706a96dd242>`(:ref:`FunctionManager<doxid-class_function_manager>`* interpreter);
		static const :ref:`FunctionManager<doxid-class_function_manager>`* :target:`getFunctionManager<doxid-class_transceiver_data_pack_interface_1a3163d14dbd51bbda5aa2a07c570e066d>`();
	};

	// direct descendants

	class :ref:`EngineDataPack<doxid-class_engine_data_pack>`;
	class :ref:`EngineDataPacks<doxid-class_engine_data_packs>`;
	class :ref:`SimulationIterationDecorator<doxid-class_simulation_iteration_decorator>`;
	class :ref:`SimulationTimeDecorator<doxid-class_simulation_time_decorator>`;
	class :ref:`StatusFunction<doxid-class_status_function>`;
	class :ref:`TransceiverFunction<doxid-class_transceiver_function>`;

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

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

	public:
		// typedefs
	
		typedef std::shared_ptr<T> :ref:`shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`;
		typedef std::shared_ptr<const T> :ref:`const_shared_ptr<doxid-class_ptr_templates_1ac36bfa374f3b63c85ba97d8cf953ce3b>`;
		typedef std::unique_ptr<T> :ref:`unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>`;
		typedef std::unique_ptr<const T> :ref:`const_unique_ptr<doxid-class_ptr_templates_1aef0eb44f9c386dbf0de54d0f5afac667>`;

.. _details-class_transceiver_data_pack_interface:

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

Base of TF Decorators.

Methods
-------

.. index:: pair: function; pySetup
.. _doxid-class_transceiver_data_pack_interface_1ad14f7dc9eb8b8e09e4281fbf20a9583e:

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

	template <class TRANSCEIVER_DATAPACK>
	:ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>` pySetup(const :ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`& tfDataPack)

Decorator **call** () function. Takes the lower decorator as a parameter. Moves the given class into a shared_ptr, which will be managed by the next decorator.



.. rubric:: Parameters:

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

	*
		- tfDataPack

		- Lower Decorator



.. rubric:: Returns:

shared_ptr referencing data from this object

.. index:: pair: function; linkedEngineName
.. _doxid-class_transceiver_data_pack_interface_1a0857c957956587af7a92f981a26ec987:

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

	virtual const std::string& linkedEngineName() const

Get name of engine this transceiver is linked to.

.. index:: pair: function; isPreprocessing
.. _doxid-class_transceiver_data_pack_interface_1a22bbf4eb17c7c35d894b2ffb4bb762c9:

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

	virtual bool isPreprocessing() const

Indicates if this is a preprocessing function.

.. index:: pair: function; runTf
.. _doxid-class_transceiver_data_pack_interface_1af3e70d106ebadb7d8cf71c48b39a9043:

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

	virtual boost::python::object runTf(
		boost::python::tuple& args,
		boost::python::dict& kwargs,
		:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
	)

Execute Transceiver Function. Base class will simply call runTf on _function.



.. rubric:: Parameters:

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

	*
		- args

		- Arguments for execution. Can be altered by any TransceiverDataPackInterfaces. Base class will only pass them along

	*
		- kwargs

		- Keyword arguments for execution. Can be altered by any TransceiverDataPackInterfaces. Base class will only pass them along



.. rubric:: Returns:

Returns result of :ref:`TransceiverFunction <doxid-class_transceiver_function>` execution.

.. index:: pair: function; updateRequestedDataPackIDs
.. _doxid-class_transceiver_data_pack_interface_1af4e5f51d7def898d42ca74da7311be31:

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

	virtual :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>` updateRequestedDataPackIDs(:ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>`&& datapackIDs = :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>`()) const

Appends its own datapack requests onto datapackIDs. Uses getRequestedDataPackIDs to check which IDs are requested by this datapack.



.. rubric:: Parameters:

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

	*
		- datapackIDs

		- Container with datapack IDs that gets expanded



.. rubric:: Returns:

Returns datapackIDs, with own datapackIDs appended

.. index:: pair: function; getRequestedDataPackIDs
.. _doxid-class_transceiver_data_pack_interface_1a93b17cbf01d3a38938ed50d64aff7ebf:

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

	virtual :ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>` getRequestedDataPackIDs() const

Returns datapack IDs of this :ref:`DataPack <doxid-class_data_pack>` that should be requested from the engines. TODO: Make protected.

.. index:: pair: function; setTFInterpreter
.. _doxid-class_transceiver_data_pack_interface_1a3626e61d35dadf407ec44706a96dd242:

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

	static void setTFInterpreter(:ref:`FunctionManager<doxid-class_function_manager>`* interpreter)

Set global TF Interpreter. All Transceiver Functions will register themselves with it upon creation.



.. rubric:: Parameters:

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

	*
		- interpreter

		- Interpreter to use