.. index:: pair: class; StatusFunction
.. _doxid-class_status_function:

class StatusFunction
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Holds a single Python function created with :ref:`StatusFunction <doxid-class_status_function>` decorator. :ref:`More...<details-class_status_function>`


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

	#include <status_function.h>
	
	class StatusFunction:
	    public :ref:`TransceiverDataPackInterface<doxid-class_transceiver_data_pack_interface>`,
	    public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// methods
	
		virtual const std::string& :ref:`linkedEngineName<doxid-class_status_function_1a5fb5bed166d4c45c20d1eba5eba0db49>`() const;
		virtual bool :ref:`isPreprocessing<doxid-class_status_function_1a854fdead67ec2a19cbe13cc06edd8440>`() const;
		:ref:`TransceiverDataPackInterface::shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>` :ref:`pySetup<doxid-class_status_function_1aa70f47d58c6ef9ea8fbe7abc9a1aa755>`(boost::python::object statusFunction);
	
		virtual boost::python::object :ref:`runTf<doxid-class_status_function_1aa688a3a25971099555af5e96e91e8bc4>`(
			boost::python::tuple& args,
			boost::python::dict& kwargs,
			:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` dataPacks
		);
	};

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_status_function:

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

Holds a single Python function created with :ref:`StatusFunction <doxid-class_status_function>` decorator.

Methods
-------

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

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

	virtual const std::string& linkedEngineName() const

Returns an empty string.

Status functions are not linked to any engine, so the string returned by this method should always be empty. The method is implemented in order to conform to the base interface.

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

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

	virtual bool isPreprocessing() const

Returns false.

Status functions don't have the concept of pre-processing. The method is implemented in order to conform to the base interface.

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

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

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

Performs actual initialization of the object.

This method is linked to the **call** () method of Python :ref:`StatusFunction <doxid-class_status_function>` decorator. It links the user-defined python function to this C++ object. It also registers the C++ object in the function manager.



.. rubric:: Parameters:

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

	*
		- statusFunction

		- User-defined python function. It will be linked to this C++ object.



.. rubric:: Returns:

shared_ptr referencing data from this object

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

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

Runs the status function.



.. rubric:: Parameters:

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

	*
		- args

		- Python args

	*
		- kwargs

		- Python keywords



.. rubric:: Returns:

Result of status function execution