org.opentrafficsim.road.gtu.generator.headway

Class DemandPattern

java.lang.Object

org.opentrafficsim.road.gtu.generator.headway.DemandPattern

All Implemented Interfaces:

Arrivals

public class DemandPattern
extends Object
implements Arrivals

Demand pattern defined by a frequency vector, time vector and interpolation.

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 22 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
DemandPattern(org.djunits.value.vdouble.vector.FrequencyVector demandVector, org.djunits.value.vdouble.vector.TimeVector timeVector, Interpolation interpolation) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.djunits.value.vdouble.vector.FrequencyVector	getDemandVector() Returns the demand vector.
org.djunits.value.vdouble.scalar.Frequency	getFrequency(org.djunits.value.vdouble.scalar.Time time, boolean sliceStart) Returns the demand at given time, which may be the sum of child objects.
Interpolation	getInterpolation() Returns the interpolation.
org.djunits.value.vdouble.vector.TimeVector	getTimeVector() Returns the time vector.
int	hashCode()
org.djunits.value.vdouble.scalar.Time	nextTimeSlice(org.djunits.value.vdouble.scalar.Time time) Returns the start time of the next time slice after the given time or null if no such slice exists.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DemandPattern

public DemandPattern(org.djunits.value.vdouble.vector.FrequencyVector demandVector,
                     org.djunits.value.vdouble.vector.TimeVector timeVector,
                     Interpolation interpolation)

Constructor.

Parameters:

demandVector - FrequencyVector; demand vector

timeVector - TimeVector; time vector

interpolation - Interpolation; interpolation

Method Detail

getDemandVector

public final org.djunits.value.vdouble.vector.FrequencyVector getDemandVector()

Returns the demand vector.

Returns:

FrequencyVector; returns the demand vector

getTimeVector

public final org.djunits.value.vdouble.vector.TimeVector getTimeVector()

Returns the time vector.

Returns:

TimeVector; returns the time vector

getInterpolation

public final Interpolation getInterpolation()

Returns the interpolation.

Returns:

Interpolation; returns the interpolation

getFrequency

public org.djunits.value.vdouble.scalar.Frequency getFrequency(org.djunits.value.vdouble.scalar.Time time,
                                                               boolean sliceStart)

Returns the demand at given time, which may be the sum of child objects. The input sliceStart is used to resolve the value at a time slice boundary in case of a stepwise (discontinuous) demand pattern. If sliceStart = true and time is a slice boundary, the demand value for after the slice boundary should be returned. In that case, the caller is processing a time slice after time, hence it's the slice start. If sliceStart = false the demand value of before the slice boundary should be returned. For continuous demand patterns, sliceStart can be ignored.

Specified by:

getFrequency in interface Arrivals

Parameters:

time - Time; simulation time

sliceStart - boolean; whether the time is at the start of an arbitrary time slice

Returns:

Frequency; returns the total demand for branching nodes, or the demand at a leaf node, at the given time

nextTimeSlice

public org.djunits.value.vdouble.scalar.Time nextTimeSlice(org.djunits.value.vdouble.scalar.Time time)

Returns the start time of the next time slice after the given time or null if no such slice exists. The next time slice starts as soon as the current slice ends, where each slice has it's own linear (or constant) demand. Thus, any change of slope in the demand pattern initiates a new slice. If time is equal to a time slice boundary, the next value should be returned.

Specified by:

nextTimeSlice in interface Arrivals

Parameters:

time - Time; time after which the first slice start time is requested

Returns:

start time of the next time slice after the given time or null if no such slice exists

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object