fkie_message_filters::FilterBase Class Reference

Base class for filters. More...

#include <fkie_message_filters/filter_base.h>

Inheritance diagram for fkie_message_filters::FilterBase:

Public Member Functions
virtual void	disconnect () noexcept=0
	Disconnect from all connected sources and sinks. More...
virtual void	reset () noexcept
	Reset filter state. More...

Detailed Description

Base class for filters.

All filters process some input and generate some output, possibly with different data types. This class provides the base class for all filter implementations.

Member Function Documentation

disconnect()

virtual void fkie_message_filters::FilterBase::disconnect ( )

pure virtualnoexcept

Disconnect from all connected sources and sinks.

Exceptions

Does not throw any exceptions.

Implemented in fkie_message_filters::Combiner< PolicyTmpl, IOs >, fkie_message_filters::Divider< Inputs >, fkie_message_filters::Divider< Inputs... >, fkie_message_filters::Sink< Inputs >, fkie_message_filters::Sink< Translate< M >::FilterType >, fkie_message_filters::Sink< In >, fkie_message_filters::Sink< Inputs... >, fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >, fkie_message_filters::Sink< IO< Inputs... > >, fkie_message_filters::Sink< sensor_msgs::ImageConstPtr, sensor_msgs::CameraInfoConstPtr >, fkie_message_filters::Source< Outputs >, fkie_message_filters::Source< Translate< M >::FilterType >, fkie_message_filters::Source< Input >, fkie_message_filters::Source< Out >, fkie_message_filters::Source< IO< Outputs... > >, fkie_message_filters::Source< IO< Inputs... >::template Select< Is... > >, fkie_message_filters::Source< IOs... >, fkie_message_filters::Source< Outputs... >, fkie_message_filters::Source< sensor_msgs::ImageConstPtr >, fkie_message_filters::Source< IO< Inputs... > >, and fkie_message_filters::Source< sensor_msgs::ImageConstPtr, sensor_msgs::CameraInfoConstPtr >.

reset()

virtual void fkie_message_filters::FilterBase::reset ( )

inlinevirtualnoexcept

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... >.

---

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

• include/fkie_message_filters/filter_base.h