Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends
ros::Subscriber Class Reference

Manages an subscription callback on a specific topic. More...

#include <subscriber.h>

List of all members.


class  Impl

Public Member Functions

uint32_t getNumPublishers () const
 Returns the number of publishers this subscriber is connected to.
std::string getTopic () const
 operator void * () const
bool operator!= (const Subscriber &rhs) const
bool operator< (const Subscriber &rhs) const
bool operator== (const Subscriber &rhs) const
void shutdown ()
 Unsubscribe the callback associated with this Subscriber.
 Subscriber ()
 Subscriber (const Subscriber &rhs)
 ~Subscriber ()

Private Types

typedef boost::shared_ptr< ImplImplPtr
typedef boost::weak_ptr< ImplImplWPtr

Private Member Functions

 Subscriber (const std::string &topic, const NodeHandle &node_handle, const SubscriptionCallbackHelperPtr &helper)

Private Attributes

ImplPtr impl_


class NodeHandle
class NodeHandleBackingCollection

Detailed Description

Manages an subscription callback on a specific topic.

A Subscriber should always be created through a call to NodeHandle::subscribe(), or copied from one that was. Once all copies of a specific Subscriber go out of scope, the subscription callback associated with that handle will stop being called. Once all Subscriber for a given topic go out of scope the topic will be unsubscribed.

Definition at line 46 of file subscriber.h.

Member Typedef Documentation

typedef boost::shared_ptr<Impl> ros::Subscriber::ImplPtr [private]

Definition at line 107 of file subscriber.h.

typedef boost::weak_ptr<Impl> ros::Subscriber::ImplWPtr [private]

Definition at line 108 of file subscriber.h.

Constructor & Destructor Documentation

Definition at line 49 of file subscriber.h.

Definition at line 70 of file subscriber.cpp.

Definition at line 75 of file subscriber.cpp.

ros::Subscriber::Subscriber ( const std::string &  topic,
const NodeHandle node_handle,
const SubscriptionCallbackHelperPtr &  helper 
) [private]

Definition at line 61 of file subscriber.cpp.

Member Function Documentation

Returns the number of publishers this subscriber is connected to.

Definition at line 97 of file subscriber.cpp.

std::string ros::Subscriber::getTopic ( ) const

Definition at line 87 of file subscriber.cpp.

ros::Subscriber::operator void * ( ) const [inline]

Definition at line 71 of file subscriber.h.

bool ros::Subscriber::operator!= ( const Subscriber rhs) const [inline]

Definition at line 83 of file subscriber.h.

bool ros::Subscriber::operator< ( const Subscriber rhs) const [inline]

Definition at line 73 of file subscriber.h.

bool ros::Subscriber::operator== ( const Subscriber rhs) const [inline]

Definition at line 78 of file subscriber.h.

Unsubscribe the callback associated with this Subscriber.

This method usually does not need to be explicitly called, as automatic shutdown happens when all copies of this Subscriber go out of scope

This method overrides the automatic reference counted unsubscribe, and immediately unsubscribes the callback associated with this Subscriber

Definition at line 79 of file subscriber.cpp.

Friends And Related Function Documentation

friend class NodeHandle [friend]

Definition at line 112 of file subscriber.h.

friend class NodeHandleBackingCollection [friend]

Definition at line 113 of file subscriber.h.

Member Data Documentation

Definition at line 110 of file subscriber.h.

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

Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Sat Dec 28 2013 17:35:53