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

#include <filter_base.hpp>

Inheritance diagram for filters::FilterBase< T >:

[legend]

Public Member Functions
bool	configure (const std::string &param_name, ros::NodeHandle node_handle=ros::NodeHandle())
	Configure the filter from the parameter server. More...

bool	configure (XmlRpc::XmlRpcValue &config)
	The public method to configure a filter from XML. More...

	FilterBase ()
	Default constructor used by Filter Factories. More...

const std::string &	getName () const
	Get the name of the filter as a string. More...

std::string	getType ()
	Get the type of the filter as a string. More...

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. More...

virtual	~FilterBase ()
	Virtual Destructor. More...

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. More...

bool	getParam (const std::string &name, bool &value) const
	Get a filter parameter as a boolean. More...

bool	getParam (const std::string &name, double &value) const
	Get a filter parameter as a double. More...

bool	getParam (const std::string &name, int &value) const
	Get a filter parameter as a int. More...

bool	getParam (const std::string &name, std::string &value) const
	Get a filter parameter as a string. More...

bool	getParam (const std::string &name, std::vector< double > &value) const
	Get a filter parameter as a std::vector<double> More...

bool	getParam (const std::string &name, std::vector< std::string > &value) const
	Get a filter parameter as a std::vector<string> More...

bool	getParam (const std::string &name, unsigned int &value) const
	Get a filter parameter as an unsigned int. More...

bool	getParam (const std::string &name, XmlRpc::XmlRpcValue &value) const
	Get a filter parameter as a XmlRpcValue. More...

bool	loadConfiguration (XmlRpc::XmlRpcValue &config)

Protected Attributes
bool	configured_
	Whether the filter has been configured. More...

std::string	filter_name_
	The name of the filter. More...

std::string	filter_type_
	The type of the filter (Used by FilterChain for Factory construction) More...

string_map_t	params_
	Storage of the parsed xml parameters. More...

Private Member Functions
bool	setNameAndType (XmlRpc::XmlRpcValue &config)
	Set the name and type of the filter from the parameter server. More...

Detailed Description

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

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

Definition at line 47 of file filter_base.hpp.

Constructor & Destructor Documentation

◆ FilterBase()

template<typename T >

filters::FilterBase< T >::FilterBase ( )

inline

Default constructor used by Filter Factories.

Definition at line 52 of file filter_base.hpp.

◆ ~FilterBase()

template<typename T >

virtual filters::FilterBase< T >::~FilterBase ( )

inlinevirtual

Virtual Destructor.

Definition at line 56 of file filter_base.hpp.

Member Function Documentation

◆ configure() [1/3]

template<typename T >

virtual bool filters::FilterBase< T >::configure ( )

protectedpure 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::MultiChannelTransferFunctionFilter< T >, filters::MultiChannelMedianFilter< T >, filters::MultiChannelMeanFilter< T >, filters::MultiChannelIncrementFilter< T >, filters::MedianFilter< T >, filters::SingleChannelTransferFunctionFilter< T >, filters::MeanFilter< T >, filters::ParamTest< T >, and filters::IncrementFilter< T >.

◆ configure() [2/3]

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 62 of file filter_base.hpp.

◆ configure() [3/3]

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

Definition at line 77 of file filter_base.hpp.

◆ getName()

template<typename T >

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

inline

Get the name of the filter as a string.

Definition at line 103 of file filter_base.hpp.

◆ getParam() [1/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		bool &	value
	)		const

inlineprotected

Get a filter parameter as a boolean.

Parameters

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

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

Definition at line 140 of file filter_base.hpp.

◆ getParam() [2/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		double &	value
	)		const

inlineprotected

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 162 of file filter_base.hpp.

◆ getParam() [3/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		int &	value
	)		const

inlineprotected

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 184 of file filter_base.hpp.

◆ getParam() [4/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::string &	value
	)		const

inlineprotected

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 118 of file filter_base.hpp.

◆ getParam() [5/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::vector< double > &	value
	)		const

inlineprotected

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 221 of file filter_base.hpp.

◆ getParam() [6/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		std::vector< std::string > &	value
	)		const

inlineprotected

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 255 of file filter_base.hpp.

◆ getParam() [7/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		unsigned int &	value
	)		const

inlineprotected

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 206 of file filter_base.hpp.

◆ getParam() [8/8]

template<typename T >

bool filters::FilterBase< T >::getParam	(	const std::string &	name,
		XmlRpc::XmlRpcValue &	value
	)		const

inlineprotected

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 288 of file filter_base.hpp.

◆ getType()

template<typename T >

std::string filters::FilterBase< T >::getType ( )

inline

Get the type of the filter as a string.

Definition at line 100 of file filter_base.hpp.

◆ loadConfiguration()

template<typename T >

bool filters::FilterBase< T >::loadConfiguration ( XmlRpc::XmlRpcValue & config )

inlineprotected

Definition at line 340 of file filter_base.hpp.

◆ setNameAndType()

template<typename T >

bool filters::FilterBase< T >::setNameAndType ( XmlRpc::XmlRpcValue & config )

inlineprivate

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

Parameters

param_name The parameter from which to read

Definition at line 315 of file filter_base.hpp.

◆ update()

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::MedianFilter< T >, filters::SingleChannelTransferFunctionFilter< T >, filters::MeanFilter< T >, filters::ParamTest< T >, filters::IncrementFilter< T >, and filters::MultiChannelFilterBase< T >.

Member Data Documentation

◆ configured_

template<typename T >

bool filters::FilterBase< T >::configured_

protected

Whether the filter has been configured.

Definition at line 306 of file filter_base.hpp.

◆ filter_name_

template<typename T >

std::string filters::FilterBase< T >::filter_name_

protected

The name of the filter.

Definition at line 302 of file filter_base.hpp.

◆ filter_type_

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 304 of file filter_base.hpp.

◆ params_

template<typename T >

string_map_t filters::FilterBase< T >::params_

protected

Storage of the parsed xml parameters.

Definition at line 309 of file filter_base.hpp.

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

filter_base.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ FilterBase()

◆ ~FilterBase()

Member Function Documentation

◆ configure() [1/3]

◆ configure() [2/3]

◆ configure() [3/3]

◆ getName()

◆ getParam() [1/8]

◆ getParam() [2/8]

◆ getParam() [3/8]

◆ getParam() [4/8]

◆ getParam() [5/8]

◆ getParam() [6/8]

◆ getParam() [7/8]

◆ getParam() [8/8]

◆ getType()

◆ loadConfiguration()

◆ setNameAndType()

◆ update()

Member Data Documentation

◆ configured_

◆ filter_name_

◆ filter_type_

◆ params_

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