gazebo::transport::CallbackHelperT< M > Class Template Reference

Callback helper Template. More...

#include <transport/transport.hh>

Inheritance diagram for gazebo::transport::CallbackHelperT< M >:

Public Member Functions
	CallbackHelperT (const boost::function< void(const M const > &)*&_cb)
	Constructor.
std::string	GetMsgType () const
	Get the typename of the message that is handled.
virtual bool	HandleData (const std::string &_newdata)
	Process new incoming data.
virtual bool	IsLocal () const
	Is the callback local?
Public Member Functions inherited from gazebo::transport::CallbackHelper
	CallbackHelper ()
	Constructor.
virtual	~CallbackHelper ()
	Destructor.
bool	GetLatching () const
	Is the callback latching?

Additional Inherited Members
Protected Attributes inherited from gazebo::transport::CallbackHelper
bool	latching

Detailed Description

template<class M>
class gazebo::transport::CallbackHelperT< M >

Callback helper Template.

Constructor & Destructor Documentation

template<class M >

gazebo::transport::CallbackHelperT< M >::CallbackHelperT ( const boost::function< void(const M const > &  )

inline

Constructor.

Parameters

[in]

_cb

boost function to call on incoming messages

Member Function Documentation

template<class M >

std::string gazebo::transport::CallbackHelperT< M >::GetMsgType ( ) const

inlinevirtual

Get the typename of the message that is handled.

Returns

String representation of the message type

Reimplemented from gazebo::transport::CallbackHelper.

References gzthrow, and NULL.

template<class M >

virtual bool gazebo::transport::CallbackHelperT< M >::HandleData ( const std::string &  _newdata )

inlinevirtual

Process new incoming data.

Parameters

[in]

_newdata

Incoming data to be processed

Returns

true if successfully processed; false otherwise

Implements gazebo::transport::CallbackHelper.

template<class M >

virtual bool gazebo::transport::CallbackHelperT< M >::IsLocal ( ) const

inlinevirtual

Is the callback local?

Returns

true if the callback is local, false if the callback is tied to a remote connection

Implements gazebo::transport::CallbackHelper.

---

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

• CallbackHelper.hh