Base class for filters. More...
#include <filter_base.h>
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 75 of file filter_base.h.
Constructor & Destructor Documentation
◆ ~FilterBase()
|
inlinevirtual |
Definition at line 78 of file filter_base.h.
Member Function Documentation
◆ disconnect()
|
pure virtualnoexcept |
Disconnect from all connected sources and sinks.
\nothrow
Implemented in fkie_message_filters::Divider< Inputs >, fkie_message_filters::Divider< Inputs... >, fkie_message_filters::Sink< Inputs >, fkie_message_filters::Sink< RosMessageEvent< M >::FilterType >, fkie_message_filters::Sink< In >, fkie_message_filters::Sink< Inputs... >, fkie_message_filters::Sink< sensor_msgs::ImageConstPtr >, fkie_message_filters::Sink< sensor_msgs::ImageConstPtr, sensor_msgs::CameraInfoConstPtr >, fkie_message_filters::Filter< In, Out >, fkie_message_filters::Filter< IO< Inputs... >, IO< Outputs... > >, fkie_message_filters::Filter< IO< Inputs... >, IO< Inputs... >::template Select< Is... > >, and fkie_message_filters::Filter< IO< Inputs... >, IO< Inputs... > >.
◆ 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.
\nothrow
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 93 of file filter_base.h.
The documentation for this class was generated from the following file: