org.opentrafficsim.kpi.sampling.indicator

Class AbstractIndicator<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>

java.lang.Object

org.opentrafficsim.kpi.sampling.indicator.AbstractIndicator<T>

Type Parameters:

T - class of the value

Direct Known Subclasses:

MeanDensity, MeanIntensity, MeanSpeed, MeanTravelTime, MeanTripLength, TotalDelay, TotalNumberOfStops, TotalTravelDistance, TotalTravelTime

public abstract class AbstractIndicator<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>
extends Object

Abstract indicator which stores the last calculated value and returns it in getValue() for an equal query, start time and end time.

Copyright (c) 2013-2016 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 1 okt. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
AbstractIndicator()

Method Summary

Modifier and Type	Method and Description
protected T	calculate(Query query, org.djunits.value.vdouble.scalar.Time endTime) Calculate value for given query until given time.
protected abstract T	calculate(Query query, org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Time endTime) Calculate value for given query over time interval.
T	getValue(Query query, org.djunits.value.vdouble.scalar.Time endTime) Get value for given query until given time, returning earlier calculated value if possible.
T	getValue(Query query, org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Time endTime) Get value for given query over time interval, returning earlier calculated value if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIndicator

public AbstractIndicator()

Method Detail

getValue

public T getValue(Query query,
                  org.djunits.value.vdouble.scalar.Time endTime)

Get value for given query until given time, returning earlier calculated value if possible.

Parameters:

query - query

endTime - start time of interval to calculate indicator over

Returns:

value for given query

getValue

public final T getValue(Query query,
                        org.djunits.value.vdouble.scalar.Time startTime,
                        org.djunits.value.vdouble.scalar.Time endTime)

Get value for given query over time interval, returning earlier calculated value if possible.

Parameters:

query - query

startTime - start time of interval to calculate indicator over

endTime - start time of interval to calculate indicator over

Returns:

value for given query

calculate

protected T calculate(Query query,
                      org.djunits.value.vdouble.scalar.Time endTime)

Calculate value for given query until given time.

Parameters:

query - query

endTime - start time of interval to calculate indicator over

Returns:

value for given query

calculate

protected abstract T calculate(Query query,
                               org.djunits.value.vdouble.scalar.Time startTime,
                               org.djunits.value.vdouble.scalar.Time endTime)

Calculate value for given query over time interval.

Parameters:

query - query

startTime - start time of interval to calculate indicator over

endTime - start time of interval to calculate indicator over

Returns:

value for given query