.. index:: pair: class; OutputEngineNode
.. _doxid-class_output_engine_node:

class OutputEngineNode
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Output node used to connect the computational graph with an :ref:`EngineClient <doxid-class_engine_client>`. :ref:`More...<details-class_output_engine_node>`


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

	#include <output_node.h>
	
	class OutputEngineNode: public :ref:`OutputNode<doxid-class_output_node>` {
	public:
		// typedefs
	
		typedef :ref:`DataPackInterface<doxid-class_data_pack_interface>`* :target:`DataPackInterfacePtr<doxid-class_output_engine_node_1a3f490229742a6305d26392c6a257bfa8>`;

		// construction
	
		:ref:`OutputEngineNode<doxid-class_output_engine_node_1a9c9d68737fc2ed8a3dff38fad2bf6599>`(
			const std::string& id,
			const std::string& engineName,
			bool publishFromCache = false,
			unsigned int computePeriod = 1
		);

		// methods
	
		virtual std::string :ref:`typeStr<doxid-class_output_engine_node_1afc8b98fb25aee6fc96367ac80996b8a9>`() const;
		:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` :ref:`getDataPacks<doxid-class_output_engine_node_1a651acbe0b20ef4c161897054f457ce8e>`();
	};

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
		);
	
		template <class T_IN>
		:ref:`InputPort<doxid-class_input_port>`<T_IN, DATA>* :ref:`getOrRegisterInput<doxid-class_output_node_1a833d82862c1d613aab1448c3e0157237>`(const std::string& id);
	
		unsigned int :ref:`getComputePeriod<doxid-class_output_node_1aa5e7ba3ccf908b41f6aa2098bbc55fb4>`();
		void :ref:`setComputePeriod<doxid-class_output_node_1a9045756afaff996c182e7d755ae85406>`(unsigned int computePeriod);
		bool :ref:`publishFromCache<doxid-class_output_node_1ae78fef42c7bdbb8a3f7c1b9b31dd3344>`();
		virtual bool :ref:`doCompute<doxid-class_output_node_1a813b1573231b6a3d5e97b16b90360fd5>`() const;

.. _details-class_output_engine_node:

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

Output node used to connect the computational graph with an :ref:`EngineClient <doxid-class_engine_client>`.

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

.. index:: pair: function; OutputEngineNode
.. _doxid-class_output_engine_node_1a9c9d68737fc2ed8a3dff38fad2bf6599:

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

	OutputEngineNode(
		const std::string& id,
		const std::string& engineName,
		bool publishFromCache = false,
		unsigned int computePeriod = 1
	)

Constructor

Methods
-------

.. index:: pair: function; typeStr
.. _doxid-class_output_engine_node_1afc8b98fb25aee6fc96367ac80996b8a9:

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

	virtual std::string typeStr() const

Returns the node 'type' as a string.

.. index:: pair: function; getDataPacks
.. _doxid-class_output_engine_node_1a651acbe0b20ef4c161897054f457ce8e:

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

	:ref:`datapacks_set_t<doxid-datapack__interface_8h_1ad5890f126b2321788e7da3a42032beff>` getDataPacks()

Returns all datapacks stored in the node and clears the cache