message_filters::SimpleFilter< M > Class Template Reference

Convenience base-class for simple filters which output a single message. More...

#include <simple_filter.h>

Inheritance diagram for message_filters::SimpleFilter< M >:

Public Types
typedef boost::function< void(const MConstPtr &)>	Callback
typedef boost::function< void(const EventType &)>	EventCallback
typedef ros::MessageEvent< M const >	EventType
typedef boost::shared_ptr< M const >	MConstPtr

Public Member Functions
const std::string &	getName ()
	Get the name of this filter. For debugging use. More...
template<typename P >
Connection	registerCallback (const boost::function< void(P)> &callback)
	Register a callback to be called when this filter has passed. More...
template<typename C >
Connection	registerCallback (const C &callback)
	Register a callback to be called when this filter has passed. More...
template<typename P >
Connection	registerCallback (void(*callback)(P))
	Register a callback to be called when this filter has passed. More...
template<typename T , typename P >
Connection	registerCallback (void(T::*callback)(P), T *t)
	Register a callback to be called when this filter has passed. More...
void	setName (const std::string &name)
	Set the name of this filter. For debugging use. More...

Protected Member Functions
void	signalMessage (const MConstPtr &msg)
	Call all registered callbacks, passing them the specified message. More...
void	signalMessage (const ros::MessageEvent< M const > &event)
	Call all registered callbacks, passing them the specified message. More...

Private Types
typedef Signal1< M >	Signal

Private Attributes
std::string	name_
Signal	signal_

Detailed Description

template<class M>
class message_filters::SimpleFilter< M >

Convenience base-class for simple filters which output a single message.

SimpleFilter provides some of the tricky callback registering functionality, so that simple filters do not have to duplicate it. It also provides getName()/setName() for debugging purposes.

Definition at line 92 of file simple_filter.h.

Member Typedef Documentation

Callback

template<class M >

typedef boost::function<void(const MConstPtr&)> message_filters::SimpleFilter< M >::Callback

Definition at line 128 of file simple_filter.h.

EventCallback

template<class M >

typedef boost::function<void(const EventType&)> message_filters::SimpleFilter< M >::EventCallback

Definition at line 130 of file simple_filter.h.

EventType

template<class M >

typedef ros::MessageEvent<M const> message_filters::SimpleFilter< M >::EventType

Definition at line 129 of file simple_filter.h.

MConstPtr

template<class M >

typedef boost::shared_ptr<M const> message_filters::SimpleFilter< M >::MConstPtr

Definition at line 127 of file simple_filter.h.

Signal

template<class M >

typedef Signal1<M> message_filters::SimpleFilter< M >::Signal

private

Definition at line 204 of file simple_filter.h.

Member Function Documentation

getName()

template<class M >

const std::string& message_filters::SimpleFilter< M >::getName ( )

inline

Get the name of this filter. For debugging use.

Definition at line 182 of file simple_filter.h.

registerCallback() [1/4]

template<class M >

template<typename P >

Connection message_filters::SimpleFilter< M >::registerCallback ( const boost::function< void(P)> &  callback )

inline

Register a callback to be called when this filter has passed.

Parameters

callback

The callback to call

Definition at line 148 of file simple_filter.h.

registerCallback() [2/4]

template<class M >

template<typename C >

Connection message_filters::SimpleFilter< M >::registerCallback ( const C &  callback )

inline

Register a callback to be called when this filter has passed.

Parameters

callback

The callback to call

Definition at line 137 of file simple_filter.h.

registerCallback() [3/4]

template<class M >

template<typename P >

Connection message_filters::SimpleFilter< M >::registerCallback ( void(*)(P)  callback )

inline

Register a callback to be called when this filter has passed.

Parameters

callback

The callback to call

Definition at line 158 of file simple_filter.h.

registerCallback() [4/4]

template<class M >

template<typename T , typename P >

Connection message_filters::SimpleFilter< M >::registerCallback ( void(T::*)(P)  callback, T *  t  )

inline

Register a callback to be called when this filter has passed.

Parameters

callback

The callback to call

Definition at line 169 of file simple_filter.h.

setName()

template<class M >

void message_filters::SimpleFilter< M >::setName ( const std::string &  name )

inline

Set the name of this filter. For debugging use.

Definition at line 178 of file simple_filter.h.

signalMessage() [1/2]

template<class M >

void message_filters::SimpleFilter< M >::signalMessage ( const MConstPtr &  msg )

inlineprotected

Call all registered callbacks, passing them the specified message.

Definition at line 188 of file simple_filter.h.

signalMessage() [2/2]

template<class M >

void message_filters::SimpleFilter< M >::signalMessage ( const ros::MessageEvent< M const > &  event )

inlineprotected

Call all registered callbacks, passing them the specified message.

Definition at line 198 of file simple_filter.h.

Member Data Documentation

name_

template<class M >

std::string message_filters::SimpleFilter< M >::name_

private

Definition at line 208 of file simple_filter.h.

signal_

template<class M >

Signal message_filters::SimpleFilter< M >::signal_

private

Definition at line 206 of file simple_filter.h.

---

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

• simple_filter.h