Public Member Functions | List of all members
fkie_message_filters::FilterBase Class Referenceabstract

Base class for filters. More...

#include <filter_base.h>

Inheritance diagram for fkie_message_filters::FilterBase:
Inheritance graph

Public Member Functions

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

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.

Definition at line 57 of file filter_base.h.

Constructor & Destructor Documentation

◆ ~FilterBase()

virtual fkie_message_filters::FilterBase::~FilterBase ( )

Definition at line 60 of file filter_base.h.

Member Function Documentation

◆ disconnect()

virtual void fkie_message_filters::FilterBase::disconnect ( )
pure virtualnoexcept

◆ reset()

virtual void fkie_message_filters::FilterBase::reset ( )

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.

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::Sequencer< Inputs >, and fkie_message_filters::Sequencer< Inputs... >.

Definition at line 75 of file filter_base.h.

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

Author(s): Timo Röhling
autogenerated on Mon Feb 28 2022 22:21:44