HistoricalLinkedHashSet (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,LinkedHashSet<E>>
  - - org.opentrafficsim.core.perception.collections.HistoricalLinkedHashSet<E>

Type Parameters:

E - element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>, HistoricalCollection<E>, HistoricalSet<E>, HistoryManager.HistoricalElement
```
public class HistoricalLinkedHashSet<E>
extends AbstractHistoricalCollection<E,LinkedHashSet<E>>
implements HistoricalSet<E>
```
LinkedHashSet-valued historical state. The current linked hash set is always maintained, and past states of the linked hash set 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. Any returned subset 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 3 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
`HistoricalLinkedHashSet(HistoryManager historyManager)`	Construct a new, empty HistoricalLinkedHashSet.
`HistoricalLinkedHashSet(HistoryManager historyManager, Collection<? extends E> c)`	Construct a new HistoricalLinkedHashSet and add all elements of a collection to it.

Method Summary

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

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
parallelStream, stream, 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.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

- Constructor Detail
  - HistoricalLinkedHashSet
```
public HistoricalLinkedHashSet(HistoryManager historyManager)
```
    Construct a new, empty HistoricalLinkedHashSet.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
  - HistoricalLinkedHashSet
```
public HistoricalLinkedHashSet(HistoryManager historyManager,
                               Collection<? extends E> c)
```
    Construct a new HistoricalLinkedHashSet and add all elements of a collection to it.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
    
    c - Collection<? extends E>; initial collection
- Method Detail
  - get
```
public LinkedHashSet<E> get()
```
    Retrieve the current, internal set. TODO document what the caller may do with the result
    
    Specified by:
    
    get in interface HistoricalCollection<E>
    
    Specified by:
    
    get in interface HistoricalSet<E>
    
    Returns:
    
    Set<E>; current set
  - get
```
public LinkedHashSet<E> get(Time time)
```
    Retrieve a past set.
    
    Specified by:
    
    get in interface HistoricalCollection<E>
    
    Specified by:
    
    get in interface HistoricalSet<E>
    
    Parameters:
    
    time - Time; time to obtain the set at
    
    Returns:
    
    Set<E>; past set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object