org.opentrafficsim.core.perception

Class HistoryManager

java.lang.Object

org.opentrafficsim.core.perception.HistoryManager

Direct Known Subclasses:

HistoryManagerDEVS

public abstract class HistoryManager
extends Object

History manager with automatic garbage collection by the java garbage collector using weak references to the Historicals.

Copyright (c) 2013-2018 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 18 jan. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HistoryManager.HistoricalElement Historical view for the history manager.

Constructor Summary

Constructors

Constructor and Description
HistoryManager()

Method Summary

Modifier and Type	Method and Description
static void	clear(nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator) Clear central manager.
protected void	endOfSimulation() Method that clears the entire memory at simulation end.
static HistoryManagerDEVS	get(nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator) Get central manager.
protected Set<HistoryManager.HistoricalElement>	getHistoricals() Returns the historicals.
(package private) abstract org.djunits.value.vdouble.scalar.Time	now() Returns the current simulation time.
void	registerHistorical(HistoryManager.HistoricalElement historical) Registers a historical.
static void	set(HistoryManagerDEVS manager, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator) Set central manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryManager

public HistoryManager()

Method Detail

get

public static HistoryManagerDEVS get(nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator)

Get central manager.

Parameters:

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

Returns:

HistoryManagerDEVS; central manager

set

public static void set(HistoryManagerDEVS manager,
                       nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator)

Set central manager.

Parameters:

manager - HistoryManagerDEVS; manager

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

clear

public static void clear(nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator)

Clear central manager. If this is not done in batch simulations, this forms a memory leak.

Parameters:

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

registerHistorical

public void registerHistorical(HistoryManager.HistoricalElement historical)

Registers a historical.

Parameters:

historical - Historical; historical to register.

getHistoricals

protected final Set<HistoryManager.HistoricalElement> getHistoricals()

Returns the historicals.

Returns:

the historicals

now

abstract org.djunits.value.vdouble.scalar.Time now()

Returns the current simulation time. This is used by historicals to time-stamp state changes.

Returns:

Time; current simulation time.

endOfSimulation

protected final void endOfSimulation()

Method that clears the entire memory at simulation end.