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

transport/transport.hh More...

#include <SubscriptionTransport.hh>

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

Public Member Functions

 SubscriptionTransport ()
 Constructor.
 
virtual ~SubscriptionTransport ()
 Destructor.
 
const ConnectionPtrGetConnection () const
 Get the connection we're using.
 
virtual bool HandleData (const std::string &_newdata)
 Output a message to a connection.
 
void Init (const ConnectionPtr &_conn, bool _latching)
 Initialize the publication link.
 
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?
 
virtual std::string GetMsgType () const
 Get the typename of the message that is handled.
 

Additional Inherited Members

- Protected Attributes inherited from gazebo::transport::CallbackHelper
bool latching
 

Detailed Description

transport/transport.hh

Handles sending data over the wire to remote subscribers

Constructor & Destructor Documentation

gazebo::transport::SubscriptionTransport::SubscriptionTransport ( )

Constructor.

virtual gazebo::transport::SubscriptionTransport::~SubscriptionTransport ( )
virtual

Destructor.

Member Function Documentation

const ConnectionPtr& gazebo::transport::SubscriptionTransport::GetConnection ( ) const

Get the connection we're using.

Returns
Pointer to the connection we're using
virtual bool gazebo::transport::SubscriptionTransport::HandleData ( const std::string &  _newdata)
virtual

Output a message to a connection.

Parameters
[in]_newdataThe message to be handled
Returns
true if the message was handled successfully, false otherwise

Implements gazebo::transport::CallbackHelper.

void gazebo::transport::SubscriptionTransport::Init ( const ConnectionPtr _conn,
bool  _latching 
)

Initialize the publication link.

Parameters
[in]_connThe connection to use
[in]_latchingIf true, latch the latest message; if false, don't latch
virtual bool gazebo::transport::SubscriptionTransport::IsLocal ( ) const
virtual

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: