Public Types | Static Public Member Functions | Static Public Attributes | List of all members
ros::ParameterAdapter< M > Struct Template Reference

Generally not for outside use. Adapts a function parameter type into the message type, event type and parameter. Allows you to retrieve a parameter type from an event type. More...

#include <parameter_adapter.h>

Public Types

typedef ros::MessageEvent< Message const > Event
 
typedef boost::remove_reference< typename boost::remove_const< M >::type >::type Message
 
typedef M Parameter
 

Static Public Member Functions

static Parameter getParameter (const Event &event)
 

Static Public Attributes

static const bool is_const = true
 

Detailed Description

template<typename M>
struct ros::ParameterAdapter< M >

Generally not for outside use. Adapts a function parameter type into the message type, event type and parameter. Allows you to retrieve a parameter type from an event type.

ParameterAdapter is generally only useful for outside use when implementing things that require message callbacks (such as the message_filters package)and you would like to support all the roscpp message parameter types

The ParameterAdapter is templated on the callback parameter type (not the bare message type), and provides 3 things:

ParameterAdapter is specialized to allow callbacks of any of the forms:

void callback(const boost::shared_ptr<M const>&);
void callback(const boost::shared_ptr<M>&);
void callback(boost::shared_ptr<M const>);
void callback(boost::shared_ptr<M>);
void callback(const M&);
void callback(M);
void callback(const MessageEvent<M const>&);
void callback(const MessageEvent<M>&);

Definition at line 69 of file parameter_adapter.h.

Member Typedef Documentation

template<typename M>
typedef ros::MessageEvent<Message const> ros::ParameterAdapter< M >::Event

Definition at line 72 of file parameter_adapter.h.

template<typename M>
typedef boost::remove_reference<typename boost::remove_const<M>::type>::type ros::ParameterAdapter< M >::Message

Definition at line 71 of file parameter_adapter.h.

template<typename M>
typedef M ros::ParameterAdapter< M >::Parameter

Definition at line 73 of file parameter_adapter.h.

Member Function Documentation

template<typename M>
static Parameter ros::ParameterAdapter< M >::getParameter ( const Event event)
inlinestatic

Definition at line 76 of file parameter_adapter.h.

Member Data Documentation

template<typename M>
const bool ros::ParameterAdapter< M >::is_const = true
static

Definition at line 74 of file parameter_adapter.h.


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


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Wed Dec 20 2017 03:58:41