Public Member Functions | Private Attributes | List of all members
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.hpp>

Public Member Functions

bool clear ()
 Clear all filters from this chain. More...
 
bool configure (std::string param_name, ros::NodeHandle node=ros::NodeHandle())
 Configure the filter chain from a configuration stored on the parameter server. More...
 
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. More...
 
 FilterChain (std::string data_type)
 Create the filter chain object. More...
 
std::vector< std::shared_ptr< filters::FilterBase< T > > > getFilters () const
 Return a copy of the vector of loaded filters (the pointers point to the actual filters used by the chain). More...
 
bool update (const T &data_in, T &data_out)
 process data through each of the filters added sequentially More...
 
 ~FilterChain ()
 

Private Attributes

buffer0_
 ! A temporary intermediate buffer More...
 
buffer1_
 ! A temporary intermediate buffer More...
 
bool configured_
 ! whether the system is configured
More...
 
pluginlib::ClassLoader< filters::FilterBase< T > > loader_
 
std::vector< std::shared_ptr< filters::FilterBase< T > > > reference_pointers_
 ! A vector of pointers to currently constructed filters More...
 

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 47 of file filter_chain.hpp.

Constructor & Destructor Documentation

◆ FilterChain()

template<typename T >
filters::FilterChain< T >::FilterChain ( std::string  data_type)
inline

Create the filter chain object.

Definition at line 53 of file filter_chain.hpp.

◆ ~FilterChain()

template<typename T >
filters::FilterChain< T >::~FilterChain ( )
inline

Definition at line 64 of file filter_chain.hpp.

Member Function Documentation

◆ clear()

template<typename T >
bool filters::FilterChain< T >::clear ( )
inline

Clear all filters from this chain.

Definition at line 130 of file filter_chain.hpp.

◆ configure() [1/2]

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_nameThe name of the filter chain to load
nodeThe node handle to use if a different namespace is required

Definition at line 74 of file filter_chain.hpp.

◆ configure() [2/2]

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 142 of file filter_chain.hpp.

◆ getFilters()

template<typename T >
std::vector<std::shared_ptr<filters::FilterBase<T> > > filters::FilterChain< T >::getFilters ( ) const
inline

Return a copy of the vector of loaded filters (the pointers point to the actual filters used by the chain).

Definition at line 256 of file filter_chain.hpp.

◆ update()

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 92 of file filter_chain.hpp.

Member Data Documentation

◆ buffer0_

template<typename T >
T filters::FilterChain< T >::buffer0_
private

! A temporary intermediate buffer

Definition at line 265 of file filter_chain.hpp.

◆ buffer1_

template<typename T >
T filters::FilterChain< T >::buffer1_
private

! A temporary intermediate buffer

Definition at line 266 of file filter_chain.hpp.

◆ configured_

template<typename T >
bool filters::FilterChain< T >::configured_
private

! whether the system is configured

Definition at line 267 of file filter_chain.hpp.

◆ loader_

template<typename T >
pluginlib::ClassLoader<filters::FilterBase<T> > filters::FilterChain< T >::loader_
private

Definition at line 50 of file filter_chain.hpp.

◆ reference_pointers_

template<typename T >
std::vector<std::shared_ptr<filters::FilterBase<T> > > filters::FilterChain< T >::reference_pointers_
private

! A vector of pointers to currently constructed filters

Definition at line 263 of file filter_chain.hpp.


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


filters
Author(s):
autogenerated on Fri Nov 11 2022 03:09:05