fkie_message_filters::combiner_policies::PolicyBase< IOs > Class Template Reference

Base class for combiner policies. More...

#include <fkie_message_filters/combiner_policies/policy_base.h>

Public Types
using	EmitterCB = std::function< void(const OutgoingTuple &)>
	Callback for assembled outputs.
using	IncomingTuples = std::tuple< helpers::io_tuple_t< IOs >... >
	Tuple type of incoming data tuples.
using	OutgoingTuple = helpers::io_tuple_t< helpers::io_concat_t< IOs... > >
	Combined tuple type for data output.

Protected Types
using	MaybeOutgoingTuples = std::tuple< boost::optional< helpers::io_tuple_t< IOs > >... >
	Tuple of outgoing tuple candidates. More...

Protected Member Functions
void	emit (const OutgoingTuple &out)
	Emit data. More...
virtual void	reset () noexcept=0
	Reset internal state. More...
void	set_emitter_callback (const EmitterCB &) noexcept
	Set output function. More...

Detailed Description

template<class... IOs>
class fkie_message_filters::combiner_policies::PolicyBase< IOs >

Base class for combiner policies.

Member Typedef Documentation

MaybeOutgoingTuples

template<class... IOs>

using fkie_message_filters::combiner_policies::PolicyBase< IOs >::MaybeOutgoingTuples = std::tuple<boost::optional<helpers::io_tuple_t<IOs> >...>

protected

Tuple of outgoing tuple candidates.

This is basically a tuple of optionals, so elements can remain empty until a suitable data element has been found by the policy.

Member Function Documentation

emit()

template<class... IOs>

void fkie_message_filters::combiner_policies::PolicyBase< IOs >::emit ( const OutgoingTuple &  out )

protected

Emit data.

This returns combined data back to the Combiner class.

reset()

template<class... IOs>

virtual void fkie_message_filters::combiner_policies::PolicyBase< IOs >::reset ( )

protectedpure virtualnoexcept

Reset internal state.

This function is called by the Combiner if the filter is reset.

Implemented in fkie_message_filters::combiner_policies::ApproximateTime< IOs >, fkie_message_filters::combiner_policies::ExactTime< IOs >, and fkie_message_filters::combiner_policies::Fifo< IOs >.

set_emitter_callback()

template<class... IOs>

void fkie_message_filters::combiner_policies::PolicyBase< IOs >::set_emitter_callback ( const EmitterCB &  )

protectednoexcept

Set output function.

This function is called by the policy whenever it has output ready to be passed on.

---

The documentation for this class was generated from the following file:

• include/fkie_message_filters/combiner_policies/policy_base.h