filters::FilterChain< T > Class Template Reference

A class which will construct and sequentially call Filters according to xml This is the primary way in which users are expected to interact with Filters. More...

#include <filter_chain.h>

List of all members.

Public Member Functions
bool	clear ()
	Clear all filters from this chain.
bool	configure (XmlRpc::XmlRpcValue &config, const std::string &filter_ns)
	Configure the filter chain This will call configure on all filters which have been added.
bool	configure (std::string param_name, ros::NodeHandle node=ros::NodeHandle())
	Configure the filter chain from a configuration stored on the parameter server.
	FilterChain (std::string data_type)
	Create the filter chain object.
bool	update (const T &data_in, T &data_out)
	process data through each of the filters added sequentially
	~FilterChain ()
Private Attributes
T	buffer0_
	! A temporary intermediate buffer
T	buffer1_
	! A temporary intermediate buffer
bool	configured_
	! whether the system is configured
pluginlib::ClassLoader < filters::FilterBase< T > >	loader_
std::vector< boost::shared_ptr < filters::FilterBase< T > > >	reference_pointers_
	! A vector of pointers to currently constructed filters

---

Detailed Description

template<typename T>
class filters::FilterChain< T >

A class which will construct and sequentially call Filters according to xml This is the primary way in which users are expected to interact with Filters.

Definition at line 42 of file filter_chain.h.

---

Constructor & Destructor Documentation

template<typename T>

filters::FilterChain< T >::FilterChain

(

std::string

data_type

)

[inline]

Create the filter chain object.

Definition at line 41 of file filter_chain.h.

template<typename T>

filters::FilterChain< T >::~FilterChain

(

)

[inline]

Definition at line 52 of file filter_chain.h.

---

Member Function Documentation

template<typename T>

bool filters::FilterChain< T >::clear

(

)

[inline]

Clear all filters from this chain.

Definition at line 118 of file filter_chain.h.

template<typename T>

bool filters::FilterChain< T >::configure	(	XmlRpc::XmlRpcValue &	config,
		const std::string &	filter_ns
	)			[inline]

Configure the filter chain This will call configure on all filters which have been added.

Definition at line 130 of file filter_chain.h.

template<typename T>

bool filters::FilterChain< T >::configure	(	std::string	param_name,
		ros::NodeHandle	node = ros::NodeHandle()
	)			[inline]

Configure the filter chain from a configuration stored on the parameter server.

Parameters:

	param_name	The name of the filter chain to load
	node	The node handle to use if a different namespace is required

Definition at line 62 of file filter_chain.h.

template<typename T>

bool filters::FilterChain< T >::update	(	const T &	data_in,
		T &	data_out
	)			[inline]

process data through each of the filters added sequentially

Definition at line 80 of file filter_chain.h.

---

Member Data Documentation

template<typename T>

T filters::FilterChain< T >::buffer0_ [private]

! A temporary intermediate buffer

Definition at line 252 of file filter_chain.h.

template<typename T>

T filters::FilterChain< T >::buffer1_ [private]

! A temporary intermediate buffer

Definition at line 253 of file filter_chain.h.

template<typename T>

bool filters::FilterChain< T >::configured_ [private]

! whether the system is configured

Definition at line 254 of file filter_chain.h.

template<typename T>

pluginlib::ClassLoader<filters::FilterBase<T> > filters::FilterChain< T >::loader_ [private]

Definition at line 38 of file filter_chain.h.

template<typename T>

std::vector<boost::shared_ptr<filters::FilterBase<T> > > filters::FilterChain< T >::reference_pointers_ [private]

! A vector of pointers to currently constructed filters

Definition at line 246 of file filter_chain.h.

---

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

• filter_chain.h