Package org.opentrafficsim.road.network.lane

Class DirectedLanePosition

java.lang.Object

org.opentrafficsim.road.network.lane.DirectedLanePosition

All Implemented Interfaces:

java.io.Serializable

public class DirectedLanePosition
extends java.lang.Object
implements java.io.Serializable

Store one position, direction and lane of a GTU.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 11, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DirectedLanePosition(Lane lane, Length position, GTUDirectionality gtuDirection)	Construct a new DirectedLanePosition.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
GTUDirectionality	getGtuDirection()	Retrieve the gtuDirection.
Lane	getLane()	Retrieve the lane.
LaneDirection	getLaneDirection()	Returns the lane direction in the direction of this lane direction.
LinkDirection	getLinkDirection()	Returns the link direction in the direction of this lane direction.
DirectedPoint	getLocation()	Retrieve the location and direction of the GTU on the lane.
Length	getPosition()	Retrieve the position on the lane.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectedLanePosition

public DirectedLanePosition(Lane lane,
                            Length position,
                            GTUDirectionality gtuDirection)
                     throws GTUException

Construct a new DirectedLanePosition.

Parameters:

lane - Lane; the lane for the position

position - Length; the position on the lane, relative to the cross section link (design line)

gtuDirection - GTUDirectionality; the direction the vehicle is driving to -- either in the direction of the design line, or against it

Throws:

GTUException - when preconditions fail

Method Detail

getLane

public final Lane getLane()

Retrieve the lane.

Returns:

Lane; the lane for the position

getPosition

public final Length getPosition()

Retrieve the position on the lane.

Returns:

Length; the position on the lane, relative to the cross section link (design line)

getGtuDirection

public final GTUDirectionality getGtuDirection()

Retrieve the gtuDirection.

Returns:

GTUDirectionality; gtuDirection the direction the vehicle is driving to -- either in the direction of the design line, or against it

getLocation

public final DirectedPoint getLocation()

Retrieve the location and direction of the GTU on the lane.

Returns:

DirectedPoint; the location and direction of the GTU on the lane

getLaneDirection

public final LaneDirection getLaneDirection()

Returns the lane direction in the direction of this lane direction.

Returns:

lane direction in the direction of this lane direction

getLinkDirection

public final LinkDirection getLinkDirection()

Returns the link direction in the direction of this lane direction.

Returns:

link direction in the direction of this lane direction

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object