Public Member Functions | Static Public Member Functions
message_transport::PublisherPluginGen Class Reference

Base class for plugins to Publisher. More...

#include <publisher_plugin.h>

Inheritance diagram for message_transport::PublisherPluginGen:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void advertise (ros::NodeHandle &nh, const std::string &base_topic, uint32_t queue_size, bool latch=true)=0
 Advertise a topic, simple version.
virtual uint32_t getNumSubscribers () const =0
 Returns the number of subscribers that are currently connected to this PublisherPlugin.
virtual std::string getTopic () const =0
 Returns the communication topic that this PublisherPlugin will publish on.
virtual std::string getTransportName () const =0
 Get a string identifier for the transport provided by this plugin.
virtual void shutdown ()=0
 Shutdown any advertisements associated with this PublisherPlugin.
virtual ~PublisherPluginGen ()

Static Public Member Functions

static std::string getLookupName (const std::string &transport_name)
 Return the lookup name of the PublisherPlugin associated with a specific transport identifier.

Detailed Description

Base class for plugins to Publisher.

Definition at line 12 of file publisher_plugin.h.


Constructor & Destructor Documentation

Definition at line 15 of file publisher_plugin.h.


Member Function Documentation

virtual void message_transport::PublisherPluginGen::advertise ( ros::NodeHandle nh,
const std::string &  base_topic,
uint32_t  queue_size,
bool  latch = true 
) [pure virtual]

Advertise a topic, simple version.

Implemented in message_transport::PublisherPlugin< M >, and message_transport::PublisherPlugin< Base >.

static std::string message_transport::PublisherPluginGen::getLookupName ( const std::string &  transport_name) [inline, static]

Return the lookup name of the PublisherPlugin associated with a specific transport identifier.

Definition at line 49 of file publisher_plugin.h.

virtual uint32_t message_transport::PublisherPluginGen::getNumSubscribers ( ) const [pure virtual]

Returns the number of subscribers that are currently connected to this PublisherPlugin.

Implemented in message_transport::SimplePublisherPlugin< Base, M >, and message_transport::SimplePublisherPlugin< M, M >.

virtual std::string message_transport::PublisherPluginGen::getTopic ( ) const [pure virtual]

Returns the communication topic that this PublisherPlugin will publish on.

Implemented in message_transport::SimplePublisherPlugin< Base, M >, and message_transport::SimplePublisherPlugin< M, M >.

virtual std::string message_transport::PublisherPluginGen::getTransportName ( ) const [pure virtual]

Get a string identifier for the transport provided by this plugin.

Implemented in message_transport::RawPublisher< M >.

virtual void message_transport::PublisherPluginGen::shutdown ( ) [pure virtual]

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


message_transport_common
Author(s): Cedric Pradalier
autogenerated on Sun Oct 5 2014 23:48:49