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

A helper class to handle callbacks when messages arrive. More...

#include <CallbackHelper.hh>

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

Public Member Functions

 CallbackHelper ()
 
virtual ~CallbackHelper ()
 
bool GetLatching () const
 
virtual std::string GetMsgType () const
 Get the typename of the message that is handled.
 
virtual bool HandleData (const std::string &newdata)=0
 
virtual bool IsLocal () const =0
 Return true if the callback is local, false if the callback is tied to a remote connection.
 

Protected Attributes

bool latching
 

Detailed Description

A helper class to handle callbacks when messages arrive.

Constructor & Destructor Documentation

gazebo::transport::CallbackHelper::CallbackHelper ( )
inline
virtual gazebo::transport::CallbackHelper::~CallbackHelper ( )
inlinevirtual

Member Function Documentation

bool gazebo::transport::CallbackHelper::GetLatching ( ) const
inline

References latching.

virtual std::string gazebo::transport::CallbackHelper::GetMsgType ( ) const
inlinevirtual

Get the typename of the message that is handled.

Reimplemented in gazebo::transport::DebugCallbackHelper, and gazebo::transport::CallbackHelperT< M >.

virtual bool gazebo::transport::CallbackHelper::HandleData ( const std::string &  newdata)
pure virtual
virtual bool gazebo::transport::CallbackHelper::IsLocal ( ) const
pure virtual

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

Implemented in gazebo::transport::DebugCallbackHelper, gazebo::transport::CallbackHelperT< M >, and gazebo::transport::SubscriptionTransport.

Member Data Documentation

bool gazebo::transport::CallbackHelper::latching
protected

Referenced by GetLatching().


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