ros::SubscriptionQueue Class Reference

#include <subscription_queue.h>

Inheritance diagram for ros::SubscriptionQueue:
Inheritance graph

List of all members.


struct  Item

Public Member Functions

call ()
 Call this callback.
void clear ()
bool full ()
void push (const SubscriptionCallbackHelperPtr &helper, const MessageDeserializerPtr &deserializer, bool has_tracked_object, const VoidConstWPtr &tracked_object, bool nonconst_need_copy, ros::Time receipt_time=ros::Time(), bool *was_full=0)
virtual bool ready ()
 Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place.
 SubscriptionQueue (const std::string &topic, int32_t queue_size, bool allow_concurrent_callbacks)
 ~SubscriptionQueue ()

Private Types

typedef std::deque< ItemD_Item

Private Member Functions

bool fullNoLock ()

Private Attributes

bool allow_concurrent_callbacks_
boost::recursive_mutex callback_mutex_
bool full_
D_Item queue_
boost::mutex queue_mutex_
uint32_t queue_size_
int32_t size_
std::string topic_

Detailed Description

Definition at line 43 of file subscription_queue.h.

Member Typedef Documentation

typedef std::deque<Item> ros::SubscriptionQueue::D_Item [private]

Definition at line 57 of file subscription_queue.h.

Constructor & Destructor Documentation

ros::SubscriptionQueue::SubscriptionQueue ( const std::string &  topic,
int32_t  queue_size,
bool  allow_concurrent_callbacks 

Definition at line 36 of file subscription_queue.cpp.

ros::SubscriptionQueue::~SubscriptionQueue (  ) 

Definition at line 44 of file subscription_queue.cpp.

Member Function Documentation

CallbackInterface::CallResult ros::SubscriptionQueue::call (  )  [virtual]

Call this callback.

The result of the call

Implements ros::CallbackInterface.

Definition at line 102 of file subscription_queue.cpp.

void ros::SubscriptionQueue::clear (  ) 

Definition at line 93 of file subscription_queue.cpp.

bool ros::SubscriptionQueue::full (  ) 

Definition at line 175 of file subscription_queue.cpp.

bool ros::SubscriptionQueue::fullNoLock (  )  [private]

Definition at line 181 of file subscription_queue.cpp.

void ros::SubscriptionQueue::push ( const SubscriptionCallbackHelperPtr &  helper,
const MessageDeserializerPtr &  deserializer,
bool  has_tracked_object,
const VoidConstWPtr &  tracked_object,
bool  nonconst_need_copy,
ros::Time  receipt_time = ros::Time(),
bool *  was_full = 0 

Definition at line 49 of file subscription_queue.cpp.

bool ros::SubscriptionQueue::ready (  )  [virtual]

Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place.

Reimplemented from ros::CallbackInterface.

Definition at line 170 of file subscription_queue.cpp.

Member Data Documentation

Definition at line 81 of file subscription_queue.h.

boost::recursive_mutex ros::SubscriptionQueue::callback_mutex_ [private]

Definition at line 83 of file subscription_queue.h.

Definition at line 76 of file subscription_queue.h.

Definition at line 79 of file subscription_queue.h.

boost::mutex ros::SubscriptionQueue::queue_mutex_ [private]

Definition at line 78 of file subscription_queue.h.

Definition at line 80 of file subscription_queue.h.

int32_t ros::SubscriptionQueue::size_ [private]

Definition at line 75 of file subscription_queue.h.

std::string ros::SubscriptionQueue::topic_ [private]

Definition at line 74 of file subscription_queue.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com, Troy Straszheim straszheim@willowgarage.com
autogenerated on Sat Mar 2 13:23:32 2013