All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::transport::DebugCallbackHelper Class Reference

CallbackHelper subclass with debug facilities. More...

#include <transport/transport.hh>

Inheritance diagram for gazebo::transport::DebugCallbackHelper:
Inheritance graph
[legend]

Public Member Functions

 DebugCallbackHelper (const boost::function< void(ConstGzStringPtr &)> &_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

CallbackHelper subclass with debug facilities.

Constructor & Destructor Documentation

gazebo::transport::DebugCallbackHelper::DebugCallbackHelper ( const boost::function< void(ConstGzStringPtr &)> &  _cb)
inline

Constructor.

Parameters
[in]_cbboost function to call on incoming messages

Member Function Documentation

std::string gazebo::transport::DebugCallbackHelper::GetMsgType ( ) const
inlinevirtual

Get the typename of the message that is handled.

Returns
String representation of the message type

Reimplemented from gazebo::transport::CallbackHelper.

virtual bool gazebo::transport::DebugCallbackHelper::HandleData ( const std::string &  _newdata)
inlinevirtual

Process new incoming data.

Parameters
[in]_newdataIncoming data to be processed
Returns
true if successfully processed; false otherwise

Implements gazebo::transport::CallbackHelper.

virtual bool gazebo::transport::DebugCallbackHelper::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: