fkie_message_filters::Source< Outputs > Class Template Reference

Base class for data providers. More...

#include <fkie_message_filters/source.h>

Inheritance diagram for fkie_message_filters::Source< Outputs >:

Collaboration diagram for fkie_message_filters::Source< Outputs >:

Public Types
using	Output = IO< Outputs... >
	Grouped output types. More...

Public Member Functions
Connection	connect_to_sink (Sink< Outputs... > &dst) noexcept
	Connect this source to a sink. More...
virtual void	disconnect () noexcept override
	Disconnect from all connected sinks. More...
void	disconnect_from_all_sinks () noexcept
	Disconnect from all connected sinks. More...
virtual void	reset () noexcept
	Reset filter state. More...

Static Public Attributes
static constexpr std::size_t	NUM_OUTPUTS = sizeof...(Outputs)
	Number of output arguments.

Protected Member Functions
void	send (const Outputs &... out)
	Pass data to all connected sinks. More...

Detailed Description

template<typename... Outputs>
class fkie_message_filters::Source< Outputs >

Base class for data providers.

In the message filter library, all data flows from sources to sinks. The sources are providers of data, which may either be generated synthetically or gathered from other sources, such as ROS topics.

Derived classes need to call the send() method to pass actual data to the connected sinks. This class does nothing but track which sinks have been connected. The send() method takes the same number and types of arguments as specified in the template instantiation.

See also

Sink

Member Typedef Documentation

Output

template<typename... Outputs>

using fkie_message_filters::Source< Outputs >::Output = IO<Outputs...>

Grouped output types.

This type can be used to define sinks with matching types.

Member Function Documentation

connect_to_sink()

template<typename... Outputs>

Connection fkie_message_filters::Source< Outputs >::connect_to_sink ( Sink< Outputs... > &  dst )

noexcept

Connect this source to a sink.

Can be called multiple times to connect multiple sinks; in that case, the sinks receive data in the same order as they have been connected. This function does basically the same thing as Sink::connect_to_source(), only from the opposite point of view.

• dst the sink that is to be connected

Returns

a connection object that can be used to monitor or sever the created connection

Exceptions

Does not throw any exceptions.

disconnect()

template<typename... Outputs>

virtual void fkie_message_filters::Source< Outputs >::disconnect ( )

overridevirtualnoexcept

Disconnect from all connected sinks.

The source implementation calls disconnect_from_all_sinks().

Exceptions

Does not throw any exceptions.

Implements fkie_message_filters::FilterBase.

Reimplemented in fkie_message_filters::Combiner< PolicyTmpl, IOs >.

disconnect_from_all_sinks()

template<typename... Outputs>

void fkie_message_filters::Source< Outputs >::disconnect_from_all_sinks ( )

noexcept

Disconnect from all connected sinks.

Severs the connection to all sinks, turning the send() method into a no-op.

Exceptions

Does not throw any exceptions.

reset()

virtual void fkie_message_filters::FilterBase::reset ( )

inlinevirtualnoexceptinherited

Reset filter state.

For stateful filters, this method resets the internal state as if the filter had just been created. Existing connections to sources and sinks are unaffected.

The default implementation does nothing.

Exceptions

Does not throw any exceptions.

Reimplemented in fkie_message_filters::Buffer< Inputs >, fkie_message_filters::Buffer< Inputs... >, fkie_message_filters::TfFilter< Inputs >, fkie_message_filters::TfFilter< Inputs... >, fkie_message_filters::Combiner< PolicyTmpl, IOs >, fkie_message_filters::Sequencer< Inputs >, and fkie_message_filters::Sequencer< Inputs... >.

send()

template<typename... Outputs>

void fkie_message_filters::Source< Outputs >::send ( const Outputs &...  out )

protected

Pass data to all connected sinks.

• out data

Exceptions

Does not throw any exceptions, but will propagate uncaught exceptions from filter callbacks.

---

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

• include/fkie_message_filters/sink.h
• include/fkie_message_filters/source.h