HistoricalTreeSet (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,S>
  - - org.opentrafficsim.core.perception.collections.AbstractHistoricalSortedSet<E,S>
    - - org.opentrafficsim.core.perception.collections.AbstractHistoricalNavigableSet<E,TreeSet<E>>
      - org.opentrafficsim.core.perception.collections.HistoricalTreeSet<E>

Type Parameters:

E - element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>, HistoricalCollection<E>, HistoricalNavigableSet<E>, HistoricalSet<E>, HistoricalSortedSet<E>, HistoryManager.HistoricalElement
```
public class HistoricalTreeSet<E>
extends AbstractHistoricalNavigableSet<E,TreeSet<E>>
```
TreeSet-valued historical state. The current tree set is always maintained, and past states of the tree 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
`HistoricalTreeSet(HistoryManager historyManager)`	Construct a new, empty HistoricalTreeSet.
`HistoricalTreeSet(HistoryManager historyManager, Collection<? extends E> c)`	Construct a new HistoricalTreeSet and fill it with the elements of the given collection.

Method Summary

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

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalNavigableSet
ceiling, descendingIterator, descendingSet, floor, headSet, higher, lower, pollFirst, pollLast, subSet, tailSet

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalSortedSet
comparator, first, headSet, last, subSet, tailSet

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.NavigableSet
headSet, iterator, subSet, tailSet

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.SortedSet
comparator, first, last, spliterator

- Constructor Detail
  - HistoricalTreeSet
```
public HistoricalTreeSet(HistoryManager historyManager)
```
    Construct a new, empty HistoricalTreeSet.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
  - HistoricalTreeSet
```
public HistoricalTreeSet(HistoryManager historyManager,
                         Collection<? extends E> c)
```
    Construct a new HistoricalTreeSet 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 TreeSet<E> get()
```
    Retrieve the current, internal navigable set. TODO document what the caller may do with the result.
    
    Returns:
    
    NavigableSet<E>; current navigable set
  - get
```
public TreeSet<E> get(Time time)
```
    Retrieve a past navigable set.
    
    Parameters:
    
    time - Time; time to obtain the navigable set at
    
    Returns:
    
    NavigableSet<E>; past navigable set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractHistoricalNavigableSet<E,TreeSet<E>>