.. index:: pair: class; TransceiverFunction
.. _doxid-class_transceiver_function:

class TransceiverFunction
=========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Holds a single transfer function decorator. :ref:`More...<details-class_transceiver_function>`


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

	#include <transceiver_function.h>
	
	class TransceiverFunction:
	    public :ref:`TransceiverDataPackInterface<doxid-class_transceiver_data_pack_interface>`,
	    public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// construction
	
		:ref:`TransceiverFunction<doxid-class_transceiver_function_1a0e881e24f93df171b05317eddfda5730>`(std::string linkedEngine, bool isPreprocessing);

		// methods
	
		virtual const std::string& :ref:`linkedEngineName<doxid-class_transceiver_function_1a42aad9886158c92a69c54964f90e6d43>`() const;
		virtual bool :ref:`isPreprocessing<doxid-class_transceiver_function_1a2a79a42ba9303d5a6980d08aa8d68679>`() const;
		:ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>` :ref:`pySetup<doxid-class_transceiver_function_1a573476ca789803466f05bc5590126e1d>`(boost::python::object transceiverFunction);
	
		virtual boost::python::object :ref:`runTf<doxid-class_transceiver_function_1a44d09781ea750aba5f610c120cd04cdd>`(
			boost::python::tuple& args,
			boost::python::dict& kwargs,
			:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
		);
	};

	// direct descendants

	class :ref:`PreprocessingFunction<doxid-class_preprocessing_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>`;

		// 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>`* :ref:`getFunctionManager<doxid-class_transceiver_data_pack_interface_1a3163d14dbd51bbda5aa2a07c570e066d>`();

.. _details-class_transceiver_function:

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

Holds a single transfer function decorator.

Construction
------------

.. index:: pair: function; TransceiverFunction
.. _doxid-class_transceiver_function_1a0e881e24f93df171b05317eddfda5730:

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

	TransceiverFunction(std::string linkedEngine, bool isPreprocessing)

Constructor.



.. rubric:: Parameters:

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

	*
		- linkedEngine

		- Name of linked engine. This TF will only be called whenever Said engine finishes a timestep

Methods
-------

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

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

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

	virtual bool isPreprocessing() const

Indicates if this is a preprocessing function.

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

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

	:ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>` pySetup(boost::python::object transceiverFunction)

Decorator **call** () function. Takes the Transfer Function as a parameter. Moves this class into a shared_ptr.



.. rubric:: Parameters:

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

	*
		- transceiverFunction

		- User defined TF



.. rubric:: Returns:

shared_ptr referencing data from this object

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

.. 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 the transfer function.



.. rubric:: Parameters:

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

	*
		- args

		- Python args

	*
		- kwargs

		- Python keywords



.. rubric:: Returns:

Returns result of TF