variant_topic_tools::Subscriber Class Reference

Variant message subscriber. More...

#include <Subscriber.h>

Classes
class	Impl
	Variant message subscriber implementation. More...

Public Member Functions
size_t	getNumPublishers () const
	Retrieve this subscriber's number of publishers. More...
std::string	getTopic () const
	Retrieve the topic this subscriber is subscribed to. More...
	operator ros::Subscriber () const
	Convert this variant message subscriber to a native ROS subscriber. More...
	operator void * () const
	Void pointer conversion. More...
void	shutdown ()
	Perform shutdown of the subscriber. More...
	Subscriber ()
	Default constructor. More...
	Subscriber (const Subscriber &src)
	Copy constructor. More...
	~Subscriber ()
	Destructor. More...

Private Types
typedef boost::shared_ptr< Impl >	ImplPtr
	Declaration of the subscriber implementation pointer type. More...
typedef boost::weak_ptr< Impl >	ImplWPtr
	Declaration of the subscriber implementation weak pointer type. More...

Private Attributes
ImplPtr	impl
	The subscriber's implementation. More...

Friends
class	MessageType

Detailed Description

Variant message subscriber.

Definition at line 36 of file Subscriber.h.

Member Typedef Documentation

typedef boost::shared_ptr<Impl> variant_topic_tools::Subscriber::ImplPtr

private

Declaration of the subscriber implementation pointer type.

Definition at line 124 of file Subscriber.h.

typedef boost::weak_ptr<Impl> variant_topic_tools::Subscriber::ImplWPtr

private

Declaration of the subscriber implementation weak pointer type.

Definition at line 129 of file Subscriber.h.

Constructor & Destructor Documentation

variant_topic_tools::Subscriber::Subscriber

(

)

Default constructor.

Definition at line 30 of file Subscriber.cpp.

variant_topic_tools::Subscriber::Subscriber

(

const Subscriber &

src

)

Copy constructor.

Definition at line 33 of file Subscriber.cpp.

variant_topic_tools::Subscriber::~Subscriber

(

)

Destructor.

Definition at line 37 of file Subscriber.cpp.

Member Function Documentation

size_t variant_topic_tools::Subscriber::getNumPublishers

(

)

const

Retrieve this subscriber's number of publishers.

Definition at line 75 of file Subscriber.cpp.

std::string variant_topic_tools::Subscriber::getTopic

(

)

const

Retrieve the topic this subscriber is subscribed to.

Definition at line 68 of file Subscriber.cpp.

variant_topic_tools::Subscriber::operator ros::Subscriber

(

)

const

Convert this variant message subscriber to a native ROS subscriber.

Definition at line 57 of file Subscriber.cpp.

variant_topic_tools::Subscriber::operator void * ( ) const

inline

Void pointer conversion.

Definition at line 65 of file Subscriber.h.

void variant_topic_tools::Subscriber::shutdown

(

)

Perform shutdown of the subscriber.

Definition at line 90 of file Subscriber.cpp.

Friends And Related Function Documentation

friend class MessageType

friend

Definition at line 37 of file Subscriber.h.

Member Data Documentation

ImplPtr variant_topic_tools::Subscriber::impl

private

The subscriber's implementation.

Definition at line 133 of file Subscriber.h.

---

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

• Subscriber.h
• Subscriber.cpp