.. index:: pair: class; FunctionManager
.. _doxid-class_function_manager:

class FunctionManager
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Manages all types of Python functions that can be run as part of NRP Core. :ref:`More...<details-class_function_manager>`


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

	#include <function_manager.h>
	
	class FunctionManager {
	public:
		// typedefs
	
		typedef std::multimap<std::string, :ref:`FunctionData<doxid-struct_function_data>`> :target:`function_datas_t<doxid-class_function_manager_1a392c76c429fdd1771453d7a2a0b01a53>`;
		typedef std::pair<FunctionManager::function_datas_t::iterator, FunctionManager::function_datas_t::iterator> :target:`linked_functions_t<doxid-class_function_manager_1ac4c2c029d0c03c116554a060985f9fe5>`;
		typedef std::tuple<bool, :ref:`datapacks_vector_t<doxid-datapack__interface_8h_1abb58261362b3fb30e93be5a3635a572e>`> :target:`status_function_results_t<doxid-class_function_manager_1aed2abe81c71478d78adfabf6a8c6a66c>`;

		// construction
	
		:target:`FunctionManager<doxid-class_function_manager_1a0667b988042e6cf6a816d3dbb6cc636b>`();
		:target:`FunctionManager<doxid-class_function_manager_1af465b492b39d117ee1160cdff5eb41f7>`(const boost::python::dict& tfGlobals);

		// methods
	
		:ref:`datapack_identifiers_set_t<doxid-datapack__interface_8h_1addc7c9f48d8b0b5f40ed49d9de29002a>` :ref:`getRequestedDataPackIDs<doxid-class_function_manager_1a241a67aee472e40822138c95b2de86bc>`() const;
		:ref:`DataPackPassingPolicy<doxid-from__engine__datapack_8h_1acc402f6e8afee8391b1f851493fc9c9a>` :target:`getDataPackPassingPolicy<doxid-class_function_manager_1aad6ad5eb1e0af61cef9c7fc315bd0caa>`() const;
		void :target:`setDataPackPassingPolicy<doxid-class_function_manager_1ae17d74ce179a1ee573b00be16de5d2ec>`(:ref:`DataPackPassingPolicy<doxid-from__engine__datapack_8h_1acc402f6e8afee8391b1f851493fc9c9a>` method);
		void :ref:`setSimulationTime<doxid-class_function_manager_1ada599a5144ac5f2b65d24d33ac595af0>`(:ref:`SimulationTime<doxid-time__utils_8h_1aadff625b29e39dc2d75a7d476d5040c1>` simulationTime);
		const :ref:`SimulationTime<doxid-time__utils_8h_1aadff625b29e39dc2d75a7d476d5040c1>`& :ref:`getSimulationTime<doxid-class_function_manager_1a11d0ce938b19aa58e026e3aeb7e51af1>`() const;
		void :ref:`setSimulationIteration<doxid-class_function_manager_1a9ae6b58fa3604c4b3e204399091fb0c0>`(unsigned long simulationIteration);
		unsigned long :ref:`getSimulationIteration<doxid-class_function_manager_1a4ce22e0bb7f9eca45aace9ca0dc701bd>`() const;
	
		void :ref:`loadDataPackFunction<doxid-class_function_manager_1a2d3c43dc5d4089d8764b46267f4ce1db>`(
			const std::string& dataPackFunctionName,
			const std::string& dataPackFunctionFilename
		);
	
		void :ref:`loadStatusFunction<doxid-class_function_manager_1ae12e26eec30ba54f7678cfeddccc3730>`(
			const std::string& statusFunctionName,
			const std::string& statusFunctionFilename
		);
	
		:ref:`datapacks_vector_t<doxid-datapack__interface_8h_1abb58261362b3fb30e93be5a3635a572e>` :ref:`executePreprocessingFunctions<doxid-class_function_manager_1a901e42df04f88673774ebd8861bbe7b5>`(
			const std::string& engineName,
			:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
		);
	
		:ref:`datapacks_vector_t<doxid-datapack__interface_8h_1abb58261362b3fb30e93be5a3635a572e>` :ref:`executeTransceiverFunctions<doxid-class_function_manager_1ae9ab57a0f45814c83fd983f8004871cc>`(
			const std::string& engineName,
			:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
		);
	
		:ref:`status_function_results_t<doxid-class_function_manager_1aed2abe81c71478d78adfabf6a8c6a66c>` :ref:`executeStatusFunction<doxid-class_function_manager_1ab0368b09156ffb85faf4e91aac9fc026>`(:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks);
	};
.. _details-class_function_manager:

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

Manages all types of Python functions that can be run as part of NRP Core.

This class is responsible for loading and running all Python functions that are supported by NRP Core. The following function types are supported:

* Preprocessing Functions

* Transceiver Functions

* Status Functions Preprocessing and Transceiver Functions will be also refered to as :ref:`DataPack <doxid-class_data_pack>` (Processing) Functions, to distinguish them from Status Functions, which have a slightly different purpose.

Methods
-------

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

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

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

Get :ref:`DataPack <doxid-class_data_pack>` IDs requested by TFs.



.. rubric:: Returns:

.. index:: pair: function; setSimulationTime
.. _doxid-class_function_manager_1ada599a5144ac5f2b65d24d33ac595af0:

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

	void setSimulationTime(:ref:`SimulationTime<doxid-time__utils_8h_1aadff625b29e39dc2d75a7d476d5040c1>` simulationTime)

Sets simulation time that will be accessible by all Python Functions.



.. rubric:: Parameters:

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

	*
		- simulationTime

		- Current simulation time from the simulation manager

.. index:: pair: function; getSimulationTime
.. _doxid-class_function_manager_1a11d0ce938b19aa58e026e3aeb7e51af1:

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

	const :ref:`SimulationTime<doxid-time__utils_8h_1aadff625b29e39dc2d75a7d476d5040c1>`& getSimulationTime() const

Returns simulation time stored by the manager.

.. index:: pair: function; setSimulationIteration
.. _doxid-class_function_manager_1a9ae6b58fa3604c4b3e204399091fb0c0:

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

	void setSimulationIteration(unsigned long simulationIteration)

Sets simulation iteration that will be accessible by all Python Functions.



.. rubric:: Parameters:

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

	*
		- simulationIteration

		- Current simulation iteration from the simulation manager

.. index:: pair: function; getSimulationIteration
.. _doxid-class_function_manager_1a4ce22e0bb7f9eca45aace9ca0dc701bd:

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

	unsigned long getSimulationIteration() const

Returns simulation iteration number stored by the manager.

.. index:: pair: function; loadDataPackFunction
.. _doxid-class_function_manager_1a2d3c43dc5d4089d8764b46267f4ce1db:

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

	void loadDataPackFunction(
		const std::string& dataPackFunctionName,
		const std::string& dataPackFunctionFilename
	)

Loads given :ref:`DataPack <doxid-class_data_pack>` Processing Function.

The function runs python code from the given file, executes all decorators found in the function definition, and stores the function with some metadata for future use.

:ref:`DataPack <doxid-class_data_pack>` Processing Functions are Transceiver Functions and Preprocessing Functions.



.. rubric:: Parameters:

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

	*
		- dataPackFunctionName

		- Name of the function, used as function's ID. The name doesn't have to match the actual name of the python function.

	*
		- dataPackFunctionFilename

		- Name of the file where the function is located.

.. index:: pair: function; loadStatusFunction
.. _doxid-class_function_manager_1ae12e26eec30ba54f7678cfeddccc3730:

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

	void loadStatusFunction(
		const std::string& statusFunctionName,
		const std::string& statusFunctionFilename
	)

Loads given status funtion.

The function runs python code from the given file, executes all decorators found in the definition of the function, and stores the function with some metadata for future use.



.. rubric:: Parameters:

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

	*
		- statusFunctionName

		- Name of the function, used as function's ID. The name doesn't have to match the actual name of the python function.

	*
		- statusFunctionFilename

		- Name of the file where the function is located.

.. index:: pair: function; executePreprocessingFunctions
.. _doxid-class_function_manager_1a901e42df04f88673774ebd8861bbe7b5:

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

	:ref:`datapacks_vector_t<doxid-datapack__interface_8h_1abb58261362b3fb30e93be5a3635a572e>` executePreprocessingFunctions(
		const std::string& engineName,
		:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
	)

Executes all Preprocessing Functions linked to an engine.



.. rubric:: Parameters:

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

	*
		- engineName

		- Name of engine



.. rubric:: Returns:

Returns results of executed Preprocessing Functions

.. index:: pair: function; executeTransceiverFunctions
.. _doxid-class_function_manager_1ae9ab57a0f45814c83fd983f8004871cc:

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

	:ref:`datapacks_vector_t<doxid-datapack__interface_8h_1abb58261362b3fb30e93be5a3635a572e>` executeTransceiverFunctions(
		const std::string& engineName,
		:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
	)

Executes all Transceiver Functions linked to an engine.



.. rubric:: Parameters:

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

	*
		- engineName

		- Name of engine



.. rubric:: Returns:

Returns results of executed Preprocessing Functions

.. index:: pair: function; executeStatusFunction
.. _doxid-class_function_manager_1ab0368b09156ffb85faf4e91aac9fc026:

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

	:ref:`status_function_results_t<doxid-class_function_manager_1aed2abe81c71478d78adfabf6a8c6a66c>` executeStatusFunction(:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks)

Executes Status Function registered loaded by the manager.

This method will run the Status Function that was loaded using ``loadStatusFunction`` method.



.. rubric:: Returns:

Results of the Status Function execution as JSON object