boone.spike

Class SpikeEventQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.PriorityBlockingQueue<SpikeEvent>

boone.spike.SpikeEventQueue

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<SpikeEvent>, java.util.Collection<SpikeEvent>, java.util.concurrent.BlockingQueue<SpikeEvent>, java.util.Queue<SpikeEvent>

Direct Known Subclasses:

SpikeEventBuffer

public class SpikeEventQueue
extends java.util.concurrent.PriorityBlockingQueue<SpikeEvent>

Queue holding SpikeEvent objects, ordered according to their timestamps. The element with the lowest timestamp is the head of the queue.

Every SpikeEventQueue has a property horizon. The method update(double) compares the timestamp of each element to the specified value and removes any element where the difference is higher than the horizon.

Version:

$Id: EventQueue.java 2285 2015-08-04 jmory $

Author:

Johannes Mory

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpikeEventQueue() Create a new SpikeEventQueue, with an infinite horizon.
SpikeEventQueue(double horizon) Create a new SpikeEventQueue, with the specified horizon.

Method Summary

Modifier and Type	Method and Description
double	getHorizon() Return the horizon of this queue.
void	setHorizon(double horizon) Set the horizon of this queue.
java.lang.String	toString()
void	update(double time) Compare the timestamp of each element to the specified value and remove any element where the difference is higher than the horizon of this queue.

Methods inherited from class java.util.concurrent.PriorityBlockingQueue

add, clear, comparator, contains, drainTo, drainTo, iterator, offer, offer, peek, poll, poll, put, remainingCapacity, remove, size, spliterator, take, toArray, toArray

Methods inherited from class java.util.AbstractQueue

addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Queue

element, remove

Methods inherited from interface java.util.Collection

addAll, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SpikeEventQueue

public SpikeEventQueue()

Create a new SpikeEventQueue, with an infinite horizon.

SpikeEventQueue

public SpikeEventQueue(double horizon)

Create a new SpikeEventQueue, with the specified horizon.

Parameters:

horizon - the horizon

Method Detail

update

public void update(double time)

Compare the timestamp of each element to the specified value and remove any element where the difference is higher than the horizon of this queue.

Parameters:

time - the value to compare against

getHorizon

public double getHorizon()

Return the horizon of this queue.

setHorizon

public void setHorizon(double horizon)

Set the horizon of this queue.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.concurrent.PriorityBlockingQueue<SpikeEvent>