filters::FilterBase< T > Class Template Reference

A Base filter class to provide a standard interface for all filters. More...

#include <filter_base.h>

Inheritance diagram for filters::FilterBase< T >:

Public Member Functions
bool	configure (XmlRpc::XmlRpcValue &config)
	The public method to configure a filter from XML.
bool	configure (const std::string &param_name, ros::NodeHandle node_handle=ros::NodeHandle())
	Configure the filter from the parameter server.
	FilterBase ()
	Default constructor used by Filter Factories.
const std::string &	getName ()
	Get the name of the filter as a string.
std::string	getType ()
	Get the type of the filter as a string.
virtual bool	update (const T &data_in, T &data_out)=0
	Update the filter and return the data seperately This is an inefficient way to do this and can be overridden in the derived class.
virtual	~FilterBase ()
	Virtual Destructor.
Protected Member Functions
virtual bool	configure ()=0
	Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class.
bool	getParam (const std::string &name, XmlRpc::XmlRpcValue &value)
	Get a filter parameter as a XmlRpcValue.
bool	getParam (const std::string &name, std::vector< std::string > &value)
	Get a filter parameter as a std::vector<string>
bool	getParam (const std::string &name, std::vector< double > &value)
	Get a filter parameter as a std::vector<double>
bool	getParam (const std::string &name, unsigned int &value)
	Get a filter parameter as an unsigned int.
bool	getParam (const std::string &name, int &value)
	Get a filter parameter as a int.
bool	getParam (const std::string &name, double &value)
	Get a filter parameter as a double.
bool	getParam (const std::string &name, std::string &value)
	Get a filter parameter as a string.
bool	loadConfiguration (XmlRpc::XmlRpcValue &config)
Protected Attributes
bool	configured_
	Whether the filter has been configured.
std::string	filter_name_
	The name of the filter.
std::string	filter_type_
	The type of the filter (Used by FilterChain for Factory construction).
string_map_t	params_
	Storage of the parsed xml parameters.
Private Member Functions
bool	setNameAndType (XmlRpc::XmlRpcValue &config)
	Set the name and type of the filter from the parameter server.

Detailed Description

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

A Base filter class to provide a standard interface for all filters.

Definition at line 45 of file filter_base.h.

Constructor & Destructor Documentation

template<typename T>

filters::FilterBase< T >::FilterBase ( ) [inline]

Default constructor used by Filter Factories.

Definition at line 50 of file filter_base.h.

template<typename T>

virtual filters::FilterBase< T >::~FilterBase ( ) [inline, virtual]

Virtual Destructor.

Definition at line 54 of file filter_base.h.

Member Function Documentation

template<typename T>

virtual bool filters::FilterBase< T >::configure ( ) [protected, pure virtual]

Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class.

Implemented in filters::MultiChannelFilterBase< T >, filters::IncrementFilter< T >, filters::MultiChannelIncrementFilter< T >, filters::MeanFilter< T >, filters::MultiChannelMeanFilter< T >, filters::MedianFilter< T >, filters::MultiChannelMedianFilter< T >, filters::ParamTest< T >, filters::SingleChannelTransferFunctionFilter< T >, and filters::MultiChannelTransferFunctionFilter< T >.

template<typename T>

bool filters::FilterBase< T >::configure ( XmlRpc::XmlRpcValue & config ) [inline]

The public method to configure a filter from XML.

Parameters:

config

The XmlRpcValue from which the filter should be initialized

Reimplemented in filters::MultiChannelFilterBase< T >.

Definition at line 75 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::configure	(	const std::string &	param_name,
		ros::NodeHandle	node_handle = `ros::NodeHandle()`
	)			`[inline]`

Configure the filter from the parameter server.

Parameters:

	The	parameter from which to read the configuration
	node_handle	The optional node handle, useful if operating in a different namespace.

Definition at line 60 of file filter_base.h.

template<typename T>

const std::string& filters::FilterBase< T >::getName ( ) [inline]

Get the name of the filter as a string.

Definition at line 101 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		XmlRpc::XmlRpcValue &	value
	)			`[inline, protected]`

Get a filter parameter as a XmlRpcValue.

Parameters:

	name	The name of the parameter
	value	The XmlRpcValue to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 261 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::vector< std::string > &	value
	)			`[inline, protected]`

Get a filter parameter as a std::vector<string>

Parameters:

	name	The name of the parameter
	value	The std::vector<sgring> to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 228 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::vector< double > &	value
	)			`[inline, protected]`

Get a filter parameter as a std::vector<double>

Parameters:

	name	The name of the parameter
	value	The std::vector<double> to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 194 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		unsigned int &	value
	)			`[inline, protected]`

Get a filter parameter as an unsigned int.

Parameters:

	name	The name of the parameter
	value	The int to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 179 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		int &	value
	)			`[inline, protected]`

Get a filter parameter as a int.

Parameters:

	name	The name of the parameter
	value	The int to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 158 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		double &	value
	)			`[inline, protected]`

Get a filter parameter as a double.

Parameters:

	name	The name of the parameter
	value	The double to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 137 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::string &	value
	)			`[inline, protected]`

Get a filter parameter as a string.

Parameters:

	name	The name of the parameter
	value	The string to set with the value

Returns:: Whether or not the parameter of name/type was set

Definition at line 116 of file filter_base.h.

template<typename T>

std::string filters::FilterBase< T >::getType ( ) [inline]

Get the type of the filter as a string.

Definition at line 98 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::loadConfiguration ( XmlRpc::XmlRpcValue & config ) [inline, protected]

Definition at line 312 of file filter_base.h.

template<typename T>

bool filters::FilterBase< T >::setNameAndType ( XmlRpc::XmlRpcValue & config ) [inline, private]

Set the name and type of the filter from the parameter server.

Parameters:

param_name

The parameter from which to read

Definition at line 287 of file filter_base.h.

template<typename T>

virtual bool filters::FilterBase< T >::update	(	const T &	data_in,
		T &	data_out
	)			`[pure virtual]`

Update the filter and return the data seperately This is an inefficient way to do this and can be overridden in the derived class.

Parameters:

	data_in	A reference to the data to be input to the filter
	data_out	A reference to the data output location

Implemented in filters::MultiChannelFilterBase< T >, filters::IncrementFilter< T >, filters::MeanFilter< T >, filters::MedianFilter< T >, filters::ParamTest< T >, and filters::SingleChannelTransferFunctionFilter< T >.

Member Data Documentation

template<typename T>

bool filters::FilterBase< T >::configured_ [protected]

Whether the filter has been configured.

Definition at line 278 of file filter_base.h.

template<typename T>

std::string filters::FilterBase< T >::filter_name_ [protected]

The name of the filter.

Definition at line 274 of file filter_base.h.

template<typename T>

std::string filters::FilterBase< T >::filter_type_ [protected]

The type of the filter (Used by FilterChain for Factory construction).

Definition at line 276 of file filter_base.h.

template<typename T>

string_map_t filters::FilterBase< T >::params_ [protected]

Storage of the parsed xml parameters.

Definition at line 281 of file filter_base.h.

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

filter_base.h

filters::FilterBase< T > Class Template Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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