A increment filter which works on doubles. More...

#include <increment.h>

Inheritance diagram for filters::IncrementFilter< T >:

Public Member Functions
virtual bool	configure ()
	Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class. More...

	IncrementFilter ()
	Construct the filter with the expected width and height. More...

virtual bool	update (const T &data_in, T &data_out)
	Update the filter and return the data seperately. More...

	~IncrementFilter ()
	Destructor to clean up. More...

Public Member Functions inherited from filters::FilterBase< T >
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 ()
	Get the name of the filter as a string. More...

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

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

Additional Inherited Members
Protected Member Functions inherited from filters::FilterBase< T >
bool	getParam (const std::string &name, std::string &value)
	Get a filter parameter as a string. More...

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

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

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

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

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

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

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

bool	loadConfiguration (XmlRpc::XmlRpcValue &config)

Protected Attributes inherited from filters::FilterBase< T >
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...

Detailed Description

A increment filter which works on doubles.

Definition at line 48 of file increment.h.

Constructor & Destructor Documentation

template<typename T >

filters::IncrementFilter< T >::IncrementFilter ( )

Construct the filter with the expected width and height.

Definition at line 70 of file increment.h.

template<typename T >

filters::IncrementFilter< T >::~IncrementFilter ( )

Destructor to clean up.

Definition at line 82 of file increment.h.

template<typename T >

bool filters::IncrementFilter< T >::configure ( )

virtual

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

Definition at line 75 of file increment.h.

template<typename T >

bool filters::IncrementFilter< T >::update	(	const T &	data_in,
		T &	data_out
	)

virtual

Update the filter and return the data seperately.

Parameters

data_in	T array with length width
data_out	T array with length width

Definition at line 88 of file increment.h.

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