ot::EventQueueImplementation Class Reference
[Core Classes]
Helper class that implements the EventQueue interface using a STL deque container.
More...
#include <EventQueueImplementation.h>
Inheritance diagram for ot::EventQueueImplementation:
Public Member Functions | |
| virtual | ~EventQueueImplementation () |
| virtual Event & | getEvent (unsigned int number=0) |
| virtual Event & | getEventNearTime (double time) |
| virtual unsigned int | getSize () |
Protected Member Functions | |
| void | insertAtTime (Event &event) |
Protected Attributes | |
| EventQueue | queue |
Detailed Description
Helper class that implements the EventQueue interface using a STL deque container.Some classes do not need the implementation of the EventQeue interfaces while others depend on it. The later should derive from this class.
- Author:
- Gerhard Reitmayr
Definition at line 68 of file EventQueueImplementation.h.
Constructor & Destructor Documentation
| ot::EventQueueImplementation::~EventQueueImplementation | ( | ) | [virtual] |
Destructor method clears queue.
Definition at line 66 of file EventQueueImplementation.cxx.
References queue.
Member Function Documentation
| Event & ot::EventQueueImplementation::getEvent | ( | unsigned int | number = 0 |
) | [virtual] |
returns the event number n back in time starting with the newest event for n = 0.
- Parameters:
-
number the number of the event to be retrieved
- Returns:
- reference to the Event
Reimplemented in ot::EventQueueNode.
Definition at line 73 of file EventQueueImplementation.cxx.
References ot::Event::null, and queue.
Referenced by ot::EventQueueNode::getEvent().
| Event & ot::EventQueueImplementation::getEventNearTime | ( | double | time | ) | [virtual] |
returns the event closes to the given point in time
- Parameters:
-
time point in the the event should be closest to
- Returns:
- reference to the found event
Reimplemented in ot::EventQueueNode.
Definition at line 84 of file EventQueueImplementation.cxx.
References queue.
Referenced by ot::EventQueueNode::getEventNearTime().
| unsigned int ot::EventQueueImplementation::getSize | ( | ) | [virtual] |
returns the size of the queue
Reimplemented in ot::EventQueueNode.
Definition at line 107 of file EventQueueImplementation.cxx.
References queue.
Referenced by ot::EventQueueNode::getSize().
| void ot::EventQueueImplementation::insertAtTime | ( | Event & | event | ) | [protected] |
inserts an event so that it is in order in time with the other events.
- Parameters:
-
event timestamped event that is inserted
Definition at line 114 of file EventQueueImplementation.cxx.
References queue, and ot::Event::time.
Referenced by ot::EventQueueNode::onEventGenerated().
Member Data Documentation
EventQueue ot::EventQueueImplementation::queue [protected] |
queue of events
Definition at line 73 of file EventQueueImplementation.h.
Referenced by getEvent(), getEventNearTime(), getSize(), insertAtTime(), ot::EventQueueNode::onEventGenerated(), and ~EventQueueImplementation().
The documentation for this class was generated from the following files: