HistoricalTreeMap (OpenTrafficSim core classes 1.6.0 API)

java.lang.Object
- org.opentrafficsim.core.perception.AbstractHistorical<K,AbstractHistoricalMap.EventMap<K,V,M>>
- - org.opentrafficsim.core.perception.collections.AbstractHistoricalMap<K,V,M>
  - - org.opentrafficsim.core.perception.collections.AbstractHistoricalSortedMap<K,V,M>
    - - org.opentrafficsim.core.perception.collections.AbstractHistoricalNavigableMap<K,V,TreeMap<K,V>>
      - org.opentrafficsim.core.perception.collections.HistoricalTreeMap<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>, HistoricalMap<K,V>, HistoricalNavigableMap<K,V>, HistoricalSortedMap<K,V>, HistoryManager.HistoricalElement
```
public class HistoricalTreeMap<K,V>
extends AbstractHistoricalNavigableMap<K,V,TreeMap<K,V>>
```
TreeMap-valued historical state. The current tree map is always maintained, and past states of the tree map are obtained by applying the events between now and the requested time in reverse.

The set views returned by this class are unmodifiable.
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 3 feb. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary
- Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalMap
  AbstractHistoricalMap.EventMap<K,V,M extends Map<K,V>>
- Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical
  AbstractHistorical.EventValue<T>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors
Constructor	Description
`HistoricalTreeMap(HistoryManager historyManager)`	Constructor.
`HistoricalTreeMap(HistoryManager historyManager, Map<? extends K,? extends V> m)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TreeMap<K,V>`	`get()`	Returns the current navigable map.
`TreeMap<K,V>`	`get(Time time)`	Returns a past navigable map.
`String`	`toString()`

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalNavigableMap
ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, headMap, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, subMap, tailMap

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalSortedMap
comparator, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalMap
clear, containsKey, containsValue, entrySet, fill, fill, get, getMap, isEmpty, keySet, put, putAll, remove, size, values

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 org.opentrafficsim.core.perception.collections.HistoricalMap
replaceAll

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface java.util.NavigableMap
headMap, subMap, tailMap

Methods inherited from interface java.util.SortedMap
comparator, entrySet, firstKey, keySet, lastKey, values

- Constructor Detail
  - HistoricalTreeMap
```
public HistoricalTreeMap(HistoryManager historyManager)
```
    Constructor.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
  - HistoricalTreeMap
```
public HistoricalTreeMap(HistoryManager historyManager,
                         Map<? extends K,? extends V> m)
```
    Constructor.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
    
    m - Map<? extends K, ? extends V>; initial map
- Method Detail
  - get
```
public TreeMap<K,V> get()
```
    Returns the current navigable map.
    
    Returns:
    
    NavigableMap; current navigable map
  - get
```
public TreeMap<K,V> get(Time time)
```
    Returns a past navigable map.
    
    Parameters:
    
    time - Time; time to obtain the navigable map at
    
    Returns:
    
    NavigableMap; past navigable map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object