Argus API
Argus Camera API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
Argus::IEventQueue Class Reference

The interface available to an EventQueue. More...

#include <EventQueue.h>

Inheritance diagram for Argus::IEventQueue:
Argus::Interface Argus::NonCopyable

List of all members.

Public Member Functions

virtual Status getEventTypes (std::vector< EventType > *types) const =0
 Returns the event types that this queue will receive.
virtual const EventgetNextEvent ()=0
 Returns the next event in the queue (that is, the event at index 0).
virtual uint32_t getSize () const =0
 Returns the number of events in the queue.
virtual const EventgetEvent (uint32_t index) const =0
 Returns the event with the given index, where index 0 corresponds to the oldest event and [getSize() - 1] is the newest.

Static Public Member Functions

static const InterfaceIDid ()

Protected Member Functions

 ~IEventQueue ()
- Protected Member Functions inherited from Argus::Interface
 Interface ()
 ~Interface ()

Detailed Description

The interface available to an EventQueue.

Definition at line 51 of file EventQueue.h.


Constructor & Destructor Documentation

Argus::IEventQueue::~IEventQueue ( )
inlineprotected

Definition at line 86 of file EventQueue.h.


Member Function Documentation

virtual const Event* Argus::IEventQueue::getEvent ( uint32_t  index) const
pure virtual

Returns the event with the given index, where index 0 corresponds to the oldest event and [getSize() - 1] is the newest.

The returned event is not removed from the queue. If index is not in [0, getSize()-1], NULL is returned.

virtual Status Argus::IEventQueue::getEventTypes ( std::vector< EventType > *  types) const
pure virtual

Returns the event types that this queue will receive.

Parameters:
[out]eventTypes,thisvector will be populated with the event types registered to this queue.
Returns:
success/status of the call.
virtual const Event* Argus::IEventQueue::getNextEvent ( )
pure virtual

Returns the next event in the queue (that is, the event at index 0).

The returned event will be removed from the queue, though the object will remain valid according to the rules described by waitForEvents(). If the queue is empty, returns NULL.

virtual uint32_t Argus::IEventQueue::getSize ( ) const
pure virtual

Returns the number of events in the queue.

static const InterfaceID& Argus::IEventQueue::id ( )
inlinestatic

Definition at line 54 of file EventQueue.h.


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