org.opentrafficsim.road.gtu.lane.tactical.following

Class HeadwayGTU

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.following.HeadwayGTU

public class HeadwayGTU
extends Object

Container for a reference to information about a LaneBasedGTU and a headway.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 1368 $, $LastChangedDate: 2015-09-02 00:20:20 +0200 (Wed, 02 Sep 2015) $, by $Author: averbraeck $, initial version 11 feb. 2015

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
HeadwayGTU(String gtuId, org.djunits.value.vdouble.scalar.Speed gtuSpeed, double distanceSI) Construct a new HeadwayGTU information object.

Method Summary

Modifier and Type	Method and Description
org.djunits.value.vdouble.scalar.Length.Rel	getDistance() Retrieve the strongly typed distance to the other GTU.
double	getDistanceSI() Retrieve the distance to the other GTU in meters.
String	getGtuId()
org.djunits.value.vdouble.scalar.Speed	getGtuSpeed()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadwayGTU

public HeadwayGTU(String gtuId,
                  org.djunits.value.vdouble.scalar.Speed gtuSpeed,
                  double distanceSI)

Construct a new HeadwayGTU information object.

Parameters:

gtuId - the id of the GTU for comparison purposes

gtuSpeed - the (perceived) speed of the GTU in front of us; can be null if unknown

distanceSI - the distance to the other GTU in meters; if the other GTU is parallel, use distance Double.NaN

Method Detail

getGtuId

public final String getGtuId()

Returns:

the id of the GTU for comparison purposes

getGtuSpeed

public final org.djunits.value.vdouble.scalar.Speed getGtuSpeed()

Returns:

the (perceived) speed of the GTU in front of us; can be null if unknown.

getDistanceSI

public final double getDistanceSI()

Retrieve the distance to the other GTU in meters.

Returns:

the distance to the other GTU in SI unit for length (meter), the value Double.NaN is used to indicate that the other GTU is parallel with the reference GTU

getDistance

public final org.djunits.value.vdouble.scalar.Length.Rel getDistance()

Retrieve the strongly typed distance to the other GTU.

Returns:

Length.Rel; the distance to the GTU, return value null indicates that the other GTU is parallel to the reference GTU

toString

public final String toString()

Overrides:

toString in class Object