Package org.opentrafficsim.core.perception.collections

Class AbstractHistoricalQueue<E,Q extends Queue<E>>

java.lang.Object

org.opentrafficsim.core.perception.AbstractHistorical<E,AbstractHistoricalCollection.EventCollection<E,C>>

org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection<E,Q>

org.opentrafficsim.core.perception.collections.AbstractHistoricalQueue<E,Q>

Type Parameters:

E - element type

Q - queue type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, HistoricalCollection<E>, HistoricalQueue<E>, HistoryManager.HistoricalElement

Direct Known Subclasses:

HistoricalPriorityQueue

public abstract class AbstractHistoricalQueue<E,Q extends Queue<E>>
extends AbstractHistoricalCollection<E,Q>
implements HistoricalQueue<E>

Queue-valued historical state. The current queue is always maintained, and past states of the queue are obtained by applying the events between now and the requested time in reverse.

The Iterator returned by this class does not support the remove() method.

Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 4 feb. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection

AbstractHistoricalCollection.AddEvent<E,C extends Collection<E>>, AbstractHistoricalCollection.EventCollection<E,C extends Collection<E>>, AbstractHistoricalCollection.RemoveEvent<E,C extends Collection<E>>

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical

AbstractHistorical.EventValue<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHistoricalQueue(HistoryManager historyManager, Q queue)	Constructor.

Method Summary

Modifier and Type	Method	Description
E	element()
boolean	offer(E e)
E	peek()
E	poll()
E	remove()

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection

add, addAll, clear, contains, containsAll, fill, fill, getCollection, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class org.opentrafficsim.core.perception.AbstractHistorical

addEvent, cleanUpHistory, getEvent, getEvents, getLastEvent, isLastState, now, removeEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalCollection

removeIf

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalQueue

get, get

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

add

Constructor Detail

AbstractHistoricalQueue

protected AbstractHistoricalQueue(HistoryManager historyManager,
                                  Q queue)

Constructor.

Parameters:

historyManager - HistoryManager; history manager

queue - Q; initial queue

Method Detail

offer

public boolean offer(E e)

Specified by:

offer in interface Queue<E>

remove

public E remove()

Specified by:

remove in interface Queue<E>

poll

public E poll()

Specified by:

poll in interface Queue<E>

peek

public E peek()

Specified by:

peek in interface Queue<E>

element

public E element()

Specified by:

element in interface Queue<E>