.. index:: pair: class; FunctionalNode<std::tuple<INPUT_TYPES...>, std::tuple<OUTPUT_TYPES...>>
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7:

template class FunctionalNode<std::tuple<INPUT_TYPES...>, std::tuple<OUTPUT_TYPES...>>
======================================================================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Implementation of a functional node in the computational graph. :ref:`More...<details-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7>`


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

	#include <functional_node.h>
	
	template <typename... INPUT_TYPES, typename... OUTPUT_TYPES>
	class FunctionalNode<std::tuple<INPUT_TYPES...>, std::tuple<OUTPUT_TYPES...>>: public :ref:`FunctionalNodeBase<doxid-class_functional_node_base>` {
	public:
		// methods
	
		template <std::size_t N, class T_IN, class T_OUT>
		:ref:`InputPort<doxid-class_input_port>`<T_IN, T_OUT>* :ref:`registerInput<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a9f981b908546fb816795931b70395687>`(const std::string& id);
	
		:ref:`Port<doxid-class_port>`* :ref:`getInputByIndex<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1ad7d7562762c78ab77a788a0a92c798a7>`(size_t idx);
		virtual :ref:`Port<doxid-class_port>`* :ref:`getInputById<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1ae591bb1fa93d26c920b4ed3a385d392e>`(const std::string& id);
	
		template <std::size_t N, class T>
		:ref:`OutputPort<doxid-class_output_port>`<T>* :ref:`registerOutput<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a2ad5dd10c60a903a56986bcc52dca8ed>`(const std::string& id);
	
		template <std::size_t N>
		:ref:`Port<doxid-class_port>`* :ref:`getOutputByIndex<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a3ed48bb6e11cf25d3ccd2b3e5df8084a>`();
	
		virtual :ref:`Port<doxid-class_port>`* :ref:`getOutputById<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1af06a2d52615965042dcedcd471b1228c>`(const std::string& id);
	
		template <std::size_t N = 0>
		:ref:`Port<doxid-class_port>`* :target:`getOutputByIdTuple<doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a304b519b0a0746233e28c7c1c6c77ccd>`(const std::string& id);
	};

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

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

	public:
		// enums
	
		enum :ref:`NodeType<doxid-class_computational_node_1a6af2021042070fa763b8f2a0d879a4c0>`;

		// fields
	
		static const static std::map<:ref:`NodeType<doxid-class_computational_node_1a6af2021042070fa763b8f2a0d879a4c0>`, std::string> :ref:`nodeTypeStr<doxid-class_computational_node_1a8dcb2d5fce4a03992f54d01cec8b8350>` = {{:ref:`ComputationalNode::Input<doxid-class_computational_node_1a6af2021042070fa763b8f2a0d879a4c0a6f802cd82eb406c67acf68827a7f12c6>`, "Input"},                                                                                            {ComputationalNode::Output, "Output"},                                                                                            {ComputationalNode::Functional, "Functional"}};

		// methods
	
		const std::string& :ref:`id<doxid-class_computational_node_1aeab0953471cf02647c0264c8b474afb5>`() const;
		:ref:`NodeType<doxid-class_computational_node_1a6af2021042070fa763b8f2a0d879a4c0>` :ref:`type<doxid-class_computational_node_1a4cb10cde56ec02dd5e31c5b5498388ed>`() const;
		virtual std::string :ref:`typeStr<doxid-class_computational_node_1a7f3ac66b0ba01255d3b4614d8451a11a>`() const;
		void :ref:`setVisited<doxid-class_computational_node_1a4d75c538b8bbc2f9c26278d27ad8a434>`(bool visited);
		bool :ref:`isVisited<doxid-class_computational_node_1aa657870e632df5c4ed11470d10e65d5f>`() const;
		void :ref:`setDoCompute<doxid-class_computational_node_1a42173436871d42cf1b3142a742541b82>`(bool doCompute);
		virtual bool :ref:`doCompute<doxid-class_computational_node_1aa48b20e4dd19b5923f47d4d4a39d19af>`() const;
	
		static std::pair<std::string, std::string> :ref:`parseNodeAddress<doxid-class_computational_node_1aa0ee3c31cff004eb3ca6c44a21b11fc5>`(
			const std::string& address,
			bool hasPort = true
		);
	
		virtual :ref:`Port<doxid-class_port>`* :ref:`getInputById<doxid-class_functional_node_base_1a8f5e1195de684247ae0c8c0e8c08c093>`(const std::string&);
		virtual :ref:`Port<doxid-class_port>`* :ref:`getOutputById<doxid-class_functional_node_base_1a5033577ad0b588268328308f43f418c0>`(const std::string&);
		virtual void :ref:`configure<doxid-class_functional_node_base_1a1ef6dcdfcbd6bd973c7ab46d7d653f6c>`();
		virtual void :ref:`compute<doxid-class_functional_node_base_1ae225abeb81c72101047b49a02e74e120>`();
		void :ref:`registerF2FEdge<doxid-class_functional_node_base_1a3bdfb4e643bde972b440530d428cbcde>`(const std::string& i_port, const std::string& address);

.. _details-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7:

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

Implementation of a functional node in the computational graph.

It stores an std::function object, '_function' which is called in the node 'compute' method and which inputs and outputs can be connected to input and output ports respectively

_function return value is bool, which is used to decide whether to send outputs or not

Methods
-------

.. index:: pair: function; registerInput
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a9f981b908546fb816795931b70395687:

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

	template <std::size_t N, class T_IN, class T_OUT>
	:ref:`InputPort<doxid-class_input_port>`<T_IN, T_OUT>* registerInput(const std::string& id)

Creates an :ref:`InputPort <doxid-class_input_port>` and connect it to an input specified by N. Returns the created port.

.. index:: pair: function; getInputByIndex
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1ad7d7562762c78ab77a788a0a92c798a7:

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

	:ref:`Port<doxid-class_port>`* getInputByIndex(size_t idx)

Returns an :ref:`InputPort <doxid-class_input_port>` by index.

.. index:: pair: function; getInputById
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1ae591bb1fa93d26c920b4ed3a385d392e:

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

	virtual :ref:`Port<doxid-class_port>`* getInputById(const std::string& id)

Returns an :ref:`InputPort <doxid-class_input_port>` by id.

.. index:: pair: function; registerOutput
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a2ad5dd10c60a903a56986bcc52dca8ed:

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

	template <std::size_t N, class T>
	:ref:`OutputPort<doxid-class_output_port>`<T>* registerOutput(const std::string& id)

Creates an :ref:`OutputPort <doxid-class_output_port>` and connect it to an output specified by N. Returns the created port.

.. index:: pair: function; getOutputByIndex
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1a3ed48bb6e11cf25d3ccd2b3e5df8084a:

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

	template <std::size_t N>
	:ref:`Port<doxid-class_port>`* getOutputByIndex()

Returns an :ref:`OutputPort <doxid-class_output_port>` by index.

.. index:: pair: function; getOutputById
.. _doxid-class_functional_node_3_01std_1_1tuple_3_01_i_n_p_u_t___t_y_p_e_s_8_8_8_01_4_00_01std_1_1tuple_3d00278c889f81afbd250c42d83dfd8e7_1af06a2d52615965042dcedcd471b1228c:

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

	virtual :ref:`Port<doxid-class_port>`* getOutputById(const std::string& id)

Returns an :ref:`OutputPort <doxid-class_output_port>` by id.