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

A subscriber to a topic. More...

#include <transport/transport.hh>

Public Member Functions

 Subscriber (const std::string &_topic, NodePtr _node)
 Constructor. More...
 
virtual ~Subscriber ()
 Destructor. More...
 
unsigned int GetCallbackId () const
 
std::string GetTopic () const
 Get the topic name. More...
 
void SetCallbackId (unsigned int _id)
 
void Unsubscribe () const
 Unsubscribe from the topic. More...
 

Detailed Description

A subscriber to a topic.

Constructor & Destructor Documentation

gazebo::transport::Subscriber::Subscriber ( const std::string &  _topic,
NodePtr  _node 
)

Constructor.

Parameters
[in]_topicThe topic we're subscribing to
[in]_nodeThe associated node
virtual gazebo::transport::Subscriber::~Subscriber ( )
virtual

Destructor.

Member Function Documentation

unsigned int gazebo::transport::Subscriber::GetCallbackId ( ) const
std::string gazebo::transport::Subscriber::GetTopic ( ) const

Get the topic name.

Returns
The topic name
void gazebo::transport::Subscriber::SetCallbackId ( unsigned int  _id)
void gazebo::transport::Subscriber::Unsubscribe ( ) const

Unsubscribe from the topic.


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