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

transport/transport.hh More...

#include <PublicationTransport.hh>

Public Member Functions

 PublicationTransport (const std::string &_topic, const std::string &_msgType)
 Constructor.
 
virtual ~PublicationTransport ()
 Destructor.
 
void AddCallback (const boost::function< void(const std::string &)> &_cb)
 Add a callback to the transport.
 
void Fini ()
 Finalize the transport.
 
const ConnectionPtr GetConnection () const
 Get the underlying connection.
 
std::string GetMsgType () const
 Get the topic type.
 
std::string GetTopic () const
 Get the topic name.
 
void Init (const ConnectionPtr &_conn, bool _latched)
 Initialize the transport.
 

Detailed Description

transport/transport.hh

Reads data from a remote advertiser, and passes the data along to local subscribers

Constructor & Destructor Documentation

gazebo::transport::PublicationTransport::PublicationTransport ( const std::string &  _topic,
const std::string &  _msgType 
)

Constructor.

Parameters
[in]_topicTopic that we're publishing
[in]_topicType of the topic that we're publishing
virtual gazebo::transport::PublicationTransport::~PublicationTransport ( )
virtual

Destructor.

Member Function Documentation

void gazebo::transport::PublicationTransport::AddCallback ( const boost::function< void(const std::string &)> &  _cb)

Add a callback to the transport.

Parameters
[in]_cbThe callback to be added
void gazebo::transport::PublicationTransport::Fini ( )

Finalize the transport.

const ConnectionPtr gazebo::transport::PublicationTransport::GetConnection ( ) const

Get the underlying connection.

Returns
Pointer to the underlying connection
std::string gazebo::transport::PublicationTransport::GetMsgType ( ) const

Get the topic type.

Returns
The topic type
std::string gazebo::transport::PublicationTransport::GetTopic ( ) const

Get the topic name.

Returns
The topic name
void gazebo::transport::PublicationTransport::Init ( const ConnectionPtr _conn,
bool  _latched 
)

Initialize the transport.

Parameters
[in]_connThe underlying connection.
[in]_latchedTrue to grab the last message sent on the topic.

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