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 (lane based) GTU 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, org.opentrafficsim.core.gtu.GTUType gtuType) Construct a new HeadwayGTU information object.
HeadwayGTU(String gtuId, org.djunits.value.vdouble.scalar.Speed gtuSpeed, org.djunits.value.vdouble.scalar.Length.Rel distance, org.opentrafficsim.core.gtu.GTUType gtuType) 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.
String	getGtuId()
org.djunits.value.vdouble.scalar.Speed	getGtuSpeed()
org.opentrafficsim.core.gtu.GTUType	getGtuType()
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,
                  org.djunits.value.vdouble.scalar.Length.Rel distance,
                  org.opentrafficsim.core.gtu.GTUType gtuType)

Construct a new HeadwayGTU information object.

Parameters:

gtuId - the id of the GTU for comparison purposes, can be null if no GTU but just headway

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

distance - the distance to the other GTU; if the other GTU is parallel, use distance null

gtuType - the perceived GTU type, can be null if GTU unknown

HeadwayGTU

public HeadwayGTU(String gtuId,
                  org.djunits.value.vdouble.scalar.Speed gtuSpeed,
                  double distanceSI,
                  org.opentrafficsim.core.gtu.GTUType gtuType)

Construct a new HeadwayGTU information object.

Parameters:

gtuId - the id of the GTU for comparison purposes, can be null if no GTU but just headway

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

distanceSI - the distance to the other GTU; if the other GTU is parallel, use distance null

gtuType - the perceived GTU type, can be null if GTU unknown

Method Detail

getGtuId

public final String getGtuId()

Returns:

the id of the GTU for comparison purposes, can be null if no GTU but just headway

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.

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

getGtuType

public final org.opentrafficsim.core.gtu.GTUType getGtuType()

Returns:

the (perceived) gtuType, can be null if no GTU but just headway

toString

public final String toString()

Overrides:

toString in class Object