Public Types | Public Member Functions | List of all members
ros::CallbackInterface Class Referenceabstract

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]

Public Types

enum  CallResult { Success, TryAgain, Invalid }
 Possible results for the call() method. More...
 

Public Member Functions

virtual CallResult call ()=0
 Call this callback. More...
 
virtual bool ready ()
 Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place. More...
 
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

◆ CallResult

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

◆ ~CallbackInterface()

virtual ros::CallbackInterface::~CallbackInterface ( )
inlinevirtual

Definition at line 61 of file callback_queue_interface.h.

Member Function Documentation

◆ call()

virtual CallResult ros::CallbackInterface::call ( )
pure virtual

◆ ready()

virtual bool ros::CallbackInterface::ready ( )
inlinevirtual

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:


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Mon Jun 1 2020 03:22:50