ros::CallbackInterface Class Reference

Abstract interface for items which can be added to a CallbackQueueInterface. More...

#include <callback_queue_interface.h>

Inheritance diagram for ros::CallbackInterface:
Inheritance graph
[legend]

List of all members.

Public Types

enum  CallResult { Success, TryAgain, Invalid }
 

Possible results for the call() method.

More...

Public Member Functions

virtual CallResult call ()=0
 Call this callback.
virtual bool ready ()
 Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place.
virtual ~CallbackInterface ()

Detailed Description

Abstract interface for items which can be added to a CallbackQueueInterface.

Definition at line 48 of file callback_queue_interface.h.


Member Enumeration Documentation

Possible results for the call() method.

Enumerator:
Success 

Call succeeded.

TryAgain 

Call not ready, try again later.

Invalid 

Call no longer valid.

Definition at line 54 of file callback_queue_interface.h.


Constructor & Destructor Documentation

virtual ros::CallbackInterface::~CallbackInterface (  )  [inline, virtual]

Definition at line 61 of file callback_queue_interface.h.


Member Function Documentation

virtual CallResult ros::CallbackInterface::call (  )  [pure virtual]
virtual bool ros::CallbackInterface::ready (  )  [inline, virtual]

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

Reimplemented in ros::SubscriptionQueue.

Definition at line 72 of file callback_queue_interface.h.


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


roscpp
Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com
autogenerated on Fri Jan 11 10:08:40 2013