.. index:: pair: class; FunctionalNodeBase
.. _doxid-class_functional_node_base:

class FunctionalNodeBase
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Non-abstract, non-templated base class for the :ref:`FunctionalNode <doxid-class_functional_node>` class. :ref:`More...<details-class_functional_node_base>`


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

	#include <functional_node.h>
	
	class FunctionalNodeBase: public :ref:`ComputationalNode<doxid-class_computational_node>` {
	public:
		// construction
	
		:target:`FunctionalNodeBase<doxid-class_functional_node_base_1a2c8f57113ee2af9000ef18cbbf105dc0>`(const std::string& id);

		// methods
	
		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);
	};

	// direct descendants

	template <typename... INPUT_TYPES, typename... OUTPUT_TYPES>
	class :ref:`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>`;

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

.. _details-class_functional_node_base:

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

Non-abstract, non-templated base class for the :ref:`FunctionalNode <doxid-class_functional_node>` class.

Its existence is necessary for storing and manipulating functional nodes in the creation of Computaional Graph edges

Methods
-------

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

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

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

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

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

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

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

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

.. index:: pair: function; configure
.. _doxid-class_functional_node_base_1a1ef6dcdfcbd6bd973c7ab46d7d653f6c:

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

	virtual void configure()

Configures the node making it ready to execute 'compute'.

.. index:: pair: function; compute
.. _doxid-class_functional_node_base_1ae225abeb81c72101047b49a02e74e120:

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

	virtual void compute()

Requests the node to execute its computation.

.. index:: pair: function; registerF2FEdge
.. _doxid-class_functional_node_base_1a3bdfb4e643bde972b440530d428cbcde:

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

	void registerF2FEdge(const std::string& i_port, const std::string& address)

Request the registration of an edge between an output port in another functional node an i_port input port in this node.

Creating edges between FNs requires that all FNs has been created. Thus the edges are only created from 'graphLoadedCB' callback, which is called externally when all nodes have been created.

A :ref:`ComputationalGraphManager <doxid-class_computational_graph_manager>` is used to access other nodes, so this function assumes that a :ref:`ComputationalGraphManager <doxid-class_computational_graph_manager>` has been instantiated and it is been used to store and manage graph nodes, this is the usual case.