.. index:: pair: class; OutputEdge
.. _doxid-class_output_edge:

template class OutputEdge
=========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Helper class used to implement Python output edge decorators. :ref:`More...<details-class_output_edge>`


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

	#include <output_edge.h>
	
	template <class T_IN, class T_OUT, OUTPUT_C<T_OUT> OUTPUT_CLASS>
	class OutputEdge {
	public:
		// construction
	
		:target:`OutputEdge<doxid-class_output_edge_1a85d6c45ee84ad63ceafffa8895005460>`();
	
		:ref:`OutputEdge<doxid-class_output_edge_1a64cc156d3f0d63eada3118faadfc3098>`(
			std::string keyword,
			std::string id,
			std::string port,
			bool publishFromCache,
			unsigned int computePeriod
		);

		// methods
	
		boost::python::object :ref:`pySetup<doxid-class_output_edge_1a8f39ad3f6cd4c6a271fe064d95f6da01>`(const boost::python::object& obj);
	};

	// direct descendants

	class :ref:`OutputDummyEdge<doxid-class_output_dummy_edge>`;
	class :ref:`OutputEngineEdge<doxid-class_output_engine_edge>`;

	template <class MSG_TYPE>
	class :ref:`OutputMQTTEdge<doxid-class_output_m_q_t_t_edge>`;

	template <class MSG_TYPE>
	class :ref:`OutputROSEdge<doxid-class_output_r_o_s_edge>`;

	class :ref:`OutputSpinnakerEdge<doxid-class_output_spinnaker_edge>`;
.. _details-class_output_edge:

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

Helper class used to implement Python output edge decorators.

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

.. index:: pair: function; OutputEdge
.. _doxid-class_output_edge_1a64cc156d3f0d63eada3118faadfc3098:

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

	OutputEdge(
		std::string keyword,
		std::string id,
		std::string port,
		bool publishFromCache,
		unsigned int computePeriod
	)

Constructor.

Methods
-------

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

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

	boost::python::object pySetup(const boost::python::object& obj)

**call** function in the decorator

It creates and registers an output node. Afterwards add a port to it and registers an edge from 'obj'. 'obj' is expected to be a Python object wrapping a Functional Node