org.opentrafficsim.road.gtu.lane.perception.headway

Class AbstractHeadway

java.lang.Object

org.opentrafficsim.road.gtu.lane.perception.headway.AbstractHeadway

All Implemented Interfaces:

Serializable, Comparable<Headway>, org.opentrafficsim.core.perception.PerceivedObject, Headway

Direct Known Subclasses:

AbstractHeadwayGTU, HeadwayConflict, HeadwayObject, HeadwayStopLine, HeadwayTrafficLight

public abstract class AbstractHeadway
extends Object
implements Headway

Container for a reference to information about a (lane based) GTU and a headway. The Headway can store information about GTUs or objects ahead of the reference GTU, behind the reference GTU, or (partially) parallel to the reference GTU. In addition to the (perceived) headway, several other pieces of information can be stored, such as (perceived) speed, (perceived) acceleration, (perceived) turn indicators, and (perceived) braking lights.
Special care must be taken in curves when perceiving headway of a GTU or object on an adjacent lane.The question is whether we perceive the parallel or ahead/behind based on a line perpendicular to the front/back of the GTU (rectangular), or perpendicular to the center line of the lane (wedge-shaped in case of a curve). The difficulty of a wedge-shaped situation is that reciprocity might be violated: in case of a clothoid, for instance, it is not sure that the point on the center line when projected from lane 1 to lane 2 is the same as the projection from lane 2 to lane 1. The same holds for shapes with sharp bends. Therefore, algorithms implementing headway should only project the reference point of the reference GTU on the center line of the adjacent lane, and then calculate the forward position and backward position on the adjacent lane based on the reference point. Still, our human perception of what is parallel and what not, is not reflected by fractional positions. See examples in http://simulation.tudelft.nl:8085/browse/OTS-113.

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: 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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.lane.perception.headway.Headway

Headway.ObjectType

Constructor Summary

Constructors

Constructor and Description
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length distance) Construct a new Headway information object, for a non-moving object ahead of us or behind us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length distance, org.djunits.value.vdouble.scalar.Length length) Construct a new Headway information object, for a non-moving object ahead of us or behind us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length overlapFront, org.djunits.value.vdouble.scalar.Length overlap, org.djunits.value.vdouble.scalar.Length overlapRear) Construct a new Headway information object, for a non-moving object parallel with us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length overlapFront, org.djunits.value.vdouble.scalar.Length overlap, org.djunits.value.vdouble.scalar.Length overlapRear, org.djunits.value.vdouble.scalar.Length length) Construct a new Headway information object, for a non-moving object parallel with us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length overlapFront, org.djunits.value.vdouble.scalar.Length overlap, org.djunits.value.vdouble.scalar.Length overlapRear, org.djunits.value.vdouble.scalar.Length length, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Acceleration acceleration) Construct a new Headway information object, for a moving object parallel with us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length overlapFront, org.djunits.value.vdouble.scalar.Length overlap, org.djunits.value.vdouble.scalar.Length overlapRear, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Acceleration acceleration) Construct a new Headway information object, for a moving object parallel with us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length distance, org.djunits.value.vdouble.scalar.Length length, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Acceleration acceleration) Construct a new Headway information object, for a moving object ahead of us or behind us.
AbstractHeadway(Headway.ObjectType objectType, String id, org.djunits.value.vdouble.scalar.Length distance, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Acceleration acceleration) Construct a new Headway information object, for a moving object ahead of us or behind us.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.djunits.value.vdouble.scalar.Acceleration	getAcceleration()
org.djunits.value.vdouble.scalar.Length	getDistance() Retrieve the strongly typed distance to the other object.
String	getId()
org.djunits.value.vdouble.scalar.Length	getLength()
Headway.ObjectType	getObjectType()
org.djunits.value.vdouble.scalar.Length	getOverlap() Return the (perceived) overlap with the other object.
org.djunits.value.vdouble.scalar.Length	getOverlapFront() Return the (perceived) front overlap to the other object.
org.djunits.value.vdouble.scalar.Length	getOverlapRear() Return the (perceived) rear overlap to the other object.
org.djunits.value.vdouble.scalar.Speed	getSpeed()
int	hashCode()
boolean	isAhead()
boolean	isBehind()
boolean	isParallel()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.road.gtu.lane.perception.headway.Headway

compareTo

Constructor Detail

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length distance,
                       org.djunits.value.vdouble.scalar.Speed speed,
                       org.djunits.value.vdouble.scalar.Acceleration acceleration)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a moving object ahead of us or behind us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

distance - the distance to the other object; if this constructor is used, distance cannot be null.

speed - the (perceived) speed of the other object; can be null if unknown.

acceleration - the (perceived) acceleration of the other object; can be null if unknown.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length distance)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a non-moving object ahead of us or behind us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

distance - the distance to the other object; if this constructor is used, distance cannot be null.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length overlapFront,
                       org.djunits.value.vdouble.scalar.Length overlap,
                       org.djunits.value.vdouble.scalar.Length overlapRear,
                       org.djunits.value.vdouble.scalar.Speed speed,
                       org.djunits.value.vdouble.scalar.Acceleration acceleration)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a moving object parallel with us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

overlapFront - the front-front distance to the other object; if this constructor is used, this value cannot be null.

overlap - the 'center' overlap with the other object; if this constructor is used, this value cannot be null.

overlapRear - the rear-rear distance to the other object; if this constructor is used, this value cannot be null.

speed - the (perceived) speed of the other object; can be null if unknown.

acceleration - the (perceived) acceleration of the other object; can be null if unknown.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length overlapFront,
                       org.djunits.value.vdouble.scalar.Length overlap,
                       org.djunits.value.vdouble.scalar.Length overlapRear)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a non-moving object parallel with us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

overlapFront - the front-front distance to the other object; if this constructor is used, this value cannot be null.

overlap - the 'center' overlap with the other object; if this constructor is used, this value cannot be null.

overlapRear - the rear-rear distance to the other object; if this constructor is used, this value cannot be null.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length distance,
                       org.djunits.value.vdouble.scalar.Length length,
                       org.djunits.value.vdouble.scalar.Speed speed,
                       org.djunits.value.vdouble.scalar.Acceleration acceleration)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a moving object ahead of us or behind us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

distance - the distance to the other object; if this constructor is used, distance cannot be null.

length - the length of the other object; if this constructor is used, length cannot be null.

speed - the (perceived) speed of the other object; can be null if unknown.

acceleration - the (perceived) acceleration of the other object; can be null if unknown.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length distance,
                       org.djunits.value.vdouble.scalar.Length length)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a non-moving object ahead of us or behind us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

distance - the distance to the other object; if this constructor is used, distance cannot be null.

length - the length of the other object; if this constructor is used, length cannot be null.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length overlapFront,
                       org.djunits.value.vdouble.scalar.Length overlap,
                       org.djunits.value.vdouble.scalar.Length overlapRear,
                       org.djunits.value.vdouble.scalar.Length length,
                       org.djunits.value.vdouble.scalar.Speed speed,
                       org.djunits.value.vdouble.scalar.Acceleration acceleration)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a moving object parallel with us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

overlapFront - the front-front distance to the other object; if this constructor is used, this value cannot be null.

overlap - the 'center' overlap with the other object; if this constructor is used, this value cannot be null.

overlapRear - the rear-rear distance to the other object; if this constructor is used, this value cannot be null.

length - the length of the other object; if this constructor is used, length cannot be null.

speed - the (perceived) speed of the other object; can be null if unknown.

acceleration - the (perceived) acceleration of the other object; can be null if unknown.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

AbstractHeadway

public AbstractHeadway(Headway.ObjectType objectType,
                       String id,
                       org.djunits.value.vdouble.scalar.Length overlapFront,
                       org.djunits.value.vdouble.scalar.Length overlap,
                       org.djunits.value.vdouble.scalar.Length overlapRear,
                       org.djunits.value.vdouble.scalar.Length length)
                throws org.opentrafficsim.core.gtu.GTUException

Construct a new Headway information object, for a non-moving object parallel with us.

Parameters:

objectType - the perceived object type, can be null if object type unknown.

id - the id of the object for comparison purposes, can not be null.

overlapFront - the front-front distance to the other object; if this constructor is used, this value cannot be null.

overlap - the 'center' overlap with the other object; if this constructor is used, this value cannot be null.

overlapRear - the rear-rear distance to the other object; if this constructor is used, this value cannot be null.

length - the length of the other object; if this constructor is used, length cannot be null.

Throws:

org.opentrafficsim.core.gtu.GTUException - when id is null, or parameters are inconsistent

Method Detail

getId

public final String getId()

Specified by:

getId in interface Headway

Returns:

String; the id of the other object for comparison purposes, cannot be null.

getLength

public final org.djunits.value.vdouble.scalar.Length getLength()

Specified by:

getLength in interface Headway

Returns:

Length; the length of the other object; can be null if unknown.

getSpeed

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

Specified by:

getSpeed in interface Headway

Returns:

Speed; the (perceived) speed of the other object; can be null if unknown.

getDistance

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

Retrieve the strongly typed distance to the other object.

Specified by:

getDistance in interface Headway

Returns:

Length; the distance to the object, return value null indicates that the other object is parallel to the reference object

getObjectType

public final Headway.ObjectType getObjectType()

Specified by:

getObjectType in interface Headway

Returns:

Length; the (perceived) object Type, can be null if no object type unknown.

getAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration getAcceleration()

Specified by:

getAcceleration in interface Headway

Returns:

Acceleration; acceleration the (perceived) acceleration of the other object; can be null if unknown.

getOverlapFront

public final org.djunits.value.vdouble.scalar.Length getOverlapFront()

Return the (perceived) front overlap to the other object. This value should be null if there is no overlap. In the figure for two GTUs below, it is distance c, positive for GTU1, negative for GTU2.

 ----------
 |  GTU 1 |          ----->
 ----------
      ---------------
      |    GTU 2    |          ----->
      ---------------
 | a  | b |     c   |
 

Specified by:

getOverlapFront in interface Headway

Returns:

Length; the (perceived) front overlap to the other object or null if there is no overlap.

getOverlapRear

public final org.djunits.value.vdouble.scalar.Length getOverlapRear()

Return the (perceived) rear overlap to the other object. This value should be null if there is no overlap.In the figure below for two GTUs, it is distance a, positive for GTU1, negative for GTU2.

 ----------
 |  GTU 1 |          ----->
 ----------
      ---------------
      |    GTU 2    |          ----->
      ---------------
 | a  | b |     c   |
 

Specified by:

getOverlapRear in interface Headway

Returns:

Length; the (perceived) rear overlap to the other object or null if there is no overlap.

getOverlap

public final org.djunits.value.vdouble.scalar.Length getOverlap()

Return the (perceived) overlap with the other object. This value should be null if there is no overlap. In the figure below for two GTUs, it is distance b, positive for GTU1 and GTU2.

 ----------
 |  GTU 1 |          ----->
 ----------
      ---------------
      |    GTU 2    |          ----->
      ---------------
 | a  | b |     c   |
 

Specified by:

getOverlap in interface Headway

Returns:

Length, the (perceived) overlap with the other object or null if there is no overlap.

isAhead

public final boolean isAhead()

Specified by:

isAhead in interface Headway

Returns:

whether the other object is in front of the reference object.

isBehind

public final boolean isBehind()

Specified by:

isBehind in interface Headway

Returns:

whether the other object is behind the reference object.

isParallel

public final boolean isParallel()

Specified by:

isParallel in interface Headway

Returns:

whether the other object is behind the reference object.

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