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

Base class for plugins to Subscriber. More...

#include <subscriber_plugin.h>

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

List of all members.

Public Member Functions

virtual uint32_t getNumPublishers () const =0
 Returns the number of publishers this subscriber is connected to.
virtual std::string getTopic () const =0
 Get the transport-specific communication topic.
virtual std::string getTransportName () const =0
 Get a string identifier for the transport provided by this plugin.
virtual void shutdown ()=0
 Unsubscribe the callback associated with this SubscriberPlugin.
virtual ~SubscriberPluginGen ()

Static Public Member Functions

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

Detailed Description

Base class for plugins to Subscriber.

Definition at line 14 of file subscriber_plugin.h.


Constructor & Destructor Documentation

Definition at line 17 of file subscriber_plugin.h.


Member Function Documentation

static std::string message_transport::SubscriberPluginGen::getLookupName ( const std::string &  transport_type) [inline, static]

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

Definition at line 44 of file subscriber_plugin.h.

virtual uint32_t message_transport::SubscriberPluginGen::getNumPublishers ( ) const [pure virtual]

Returns the number of publishers this subscriber is connected to.

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

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

Get the transport-specific communication topic.

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

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

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

Implemented in message_transport::RawSubscriber< M >.

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

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


message_transport_common
Author(s): Cedric Pradalier
autogenerated on Sat Dec 28 2013 16:56:55