HistoricalPriorityQueue (Open Traffic Sim core classes 2.00.04 API)

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,PriorityQueue<E>>
    - - org.opentrafficsim.core.perception.collections.HistoricalPriorityQueue<E>

Type Parameters:

E - element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, HistoricalCollection<E>, HistoricalQueue<E>, HistoryManager.HistoricalElement
```
public class HistoricalPriorityQueue<E>
extends AbstractHistoricalQueue<E,PriorityQueue<E>>
```
PriorityQueue-valued historical state. The current priority queue is always maintained, and past states of the priority 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(), add() and set() methods. Any returned sublist is unmodifiable.
Copyright (c) 2013-2020 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
Constructor	Description
`HistoricalPriorityQueue(HistoryManager historyManager)`	Construct a new, empty HistoricalPriorityQueue.
`HistoricalPriorityQueue(HistoryManager historyManager, Collection<? extends E> c)`	Construct a new HistoricalPriorityQueue and fill it with the elements of the given collection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PriorityQueue<E>`	`get()`	Retrieve the current, internal queue.
`PriorityQueue<E>`	`get(Time time)`	Retrieve a past queue.
`String`	`toString()`

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalQueue
element, offer, peek, poll, 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, 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 java.lang.Iterable
forEach

Methods inherited from interface java.util.Queue
add

- Constructor Detail
  - HistoricalPriorityQueue
```
public HistoricalPriorityQueue(HistoryManager historyManager)
```
    Construct a new, empty HistoricalPriorityQueue.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
  - HistoricalPriorityQueue
```
public HistoricalPriorityQueue(HistoryManager historyManager,
                               Collection<? extends E> c)
```
    Construct a new HistoricalPriorityQueue and fill it with the elements of the given collection.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
    
    c - Collection<? extends E>; initial collection
- Method Detail
  - get
```
public PriorityQueue<E> get()
```
    Retrieve the current, internal queue. TODO document what the caller may do with the result
    
    Returns:
    
    Queue<E>; current queue
  - get
```
public PriorityQueue<E> get(Time time)
```
    Retrieve a past queue.
    
    Parameters:
    
    time - Time; time to obtain the queue at
    
    Returns:
    
    Queue<E>; past queue
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object