Primary namespace. More...

Namespaces
namespace	combiner_policies
	Combiner policies.

Classes
class	Buffer
	Store and forward data. More...

class	CameraPublisher
	Publish consumed data to ROS camera topics. More...

class	CameraSubscriber
	Subscribe to ROS camera topics as data provider. More...

class	Combiner
	Combine multiple sources into a single one. More...

class	Divider
	Split an N-ary source into N unary ones. More...

class	Filter
	Typed base class for filters. More...

class	FilterBase
	Base class for filters. More...

class	ImagePublisher
	Publish consumed data to a ROS image topic. More...

class	ImageSubscriber
	Subscribe to a ROS image topic as data provider. More...

class	IO
	Group multiple data types as filter input or output. More...

class	Publisher
	Publish consumed data on a ROS topic. More...

class	PublisherBase
	Base class for ROS publishers in a filter pipeline. More...

class	Selector
	Reorder or reduce an N-ary filter. More...

class	Sequencer
	Enforce correct temporal order. More...

class	SimpleUserFilter
	Simplified filter with user-defined callback function. More...

class	Sink
	Base class for data consumers. More...

class	Source
	Base class for data providers. More...

class	Subscriber
	Subscribe to a ROS topic as data provider. More...

class	SubscriberBase
	Base class for ROS subscribers in a filter pipeline. More...

class	TfFilter
	Wait for TF transformations for incoming messages. More...

class	UserFilter
	Generic filter with user-defined callback function. More...

class	UserSource
	Manually operated data source. More...

Typedefs
using	Connection = helpers::Connection
	Tracks connections from sources to sinks.

template<class... Types>
using	FilterCB = typename helpers::FilterCB< Types... >::Type
	Callback function for customizable filters.

Enumerations
enum class	BufferPolicy { Discard , Queue , Passthru }
	Buffer policy. More...

enum class	TfFilterResult { TransformAvailable , EmptyFrameID , TransformExpired , TransformFailed , QueueOverflow , UnknownFailure }
	TF transformation results. More...

Functions
template<typename Filter1 , typename Filter2 , typename... MoreFilters>
void	chain (Filter1 &flt1, Filter2 &flt2, MoreFilters &... filters) noexcept
	Convenience function to chain multiple filters.

const rclcpp::Logger &	get_logger () noexcept
	Return the currently configured ROS logger.

void	set_logger (const rclcpp::Node::SharedPtr &node, const std::string &name=std::string())
	Configure ROS logging.

FKIE_MF_BEGIN_ABI_NAMESPACE void	set_logger (const std::string &name)
	Configure ROS logging.

Detailed Description

Primary namespace.

Typedef Documentation

◆ FilterCB

template<class... Types>

using fkie_message_filters::FilterCB = typedef typename helpers::FilterCB<Types...>::Type

Callback function for customizable filters.

See also: UserFilter, SimpleUserFilter

Enumeration Type Documentation

◆ BufferPolicy

enum class fkie_message_filters::BufferPolicy

strong

Buffer policy.

An enumeration of the possible policies which can be enacted by a Buffer.

Enumerator

Discard

Discard all data.

Turns the buffer into a black hole that lets all incoming data vanish.

Queue

Queue for later use.

Stores incoming data for until consumed by .

Passthru

Forward data immediately.

All data is forwarded to the connected sinks immediately, as if the buffer did not exist.

◆ TfFilterResult

enum class fkie_message_filters::TfFilterResult

strong

TF transformation results.

These results are used to indiciate specific failure modes in the TfFilter failure callback.

See also: TfFilter::set_filter_failure_function()

Enumerator
TransformAvailable	Success.
EmptyFrameID	The message has an empty TF frame ID and cannot be transformed.
TransformExpired	The requested transform is no longer available, likely because the message is too old.
TransformFailed	The requested transform is unavailable.
QueueOverflow	The message has been dropped because of a queue overflow.
UnknownFailure	Unknown failure reason.

Function Documentation

◆ chain()

template<typename Filter1 , typename Filter2 , typename... MoreFilters>

void fkie_message_filters::chain	(	Filter1 &	flt1,
		Filter2 &	flt2,
		MoreFilters &...	filters
	)

noexcept

Convenience function to chain multiple filters.

Basically calls Source::connect_to_sink() on adjacent filters to form a chain.

◆ set_logger() [1/2]

void fkie_message_filters::set_logger	(	const rclcpp::Node::SharedPtr &	node,
		const std::string &	name = `std::string()`
	)

Configure ROS logging.

node the ROS node instance that serves as parent for the logger
name if not empty, create a named child logger from node instead of using its logger directly.

◆ set_logger() [2/2]

FKIE_MF_BEGIN_ABI_NAMESPACE void fkie_message_filters::set_logger ( const std::string & name )

Configure ROS logging.

name the name that is to be used for logging

Namespaces

Classes

Typedefs

Enumerations

Functions