Interface to the core EventQueue methods.
Definition at line 64 of file EventQueue.h.
|
| virtual Status | getEventTypes (std::vector< EventType > *types) const =0 |
| | Returns the event types that this queue will receive. More...
|
| |
| virtual const Event * | getNextEvent ()=0 |
| | Returns the next event in the queue (that is, the event at index 0). More...
|
| |
| virtual uint32_t | getSize () const =0 |
| | Returns the number of events in the queue. More...
|
| |
| virtual const Event * | getEvent (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. More...
|
| |
◆ ~IEventQueue()
| Argus::IEventQueue::~IEventQueue |
( |
| ) |
|
|
inlineprotected |
◆ getEvent()
| 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.
◆ getEventTypes()
| virtual Status Argus::IEventQueue::getEventTypes |
( |
std::vector< EventType > * |
types | ) |
const |
|
pure virtual |
Returns the event types that this queue will receive.
- Parameters
-
| [out] | types | This vector will be populated with the event types registered to this queue. |
- Returns
- success/status of the call.
◆ getNextEvent()
| 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.
◆ getSize()
| virtual uint32_t Argus::IEventQueue::getSize |
( |
| ) |
const |
|
pure virtual |
Returns the number of events in the queue.
◆ id()
The documentation for this class was generated from the following file:
