org.opentrafficsim.core.network

Class LinkLocation<LINKID,NODEID>

java.lang.Object

org.opentrafficsim.core.network.LinkLocation<LINKID,NODEID>

Type Parameters:

NODEID - the ID type of the Node, e.g., String.

LINKID - the ID type of the Link, e.g., String.

public class LinkLocation<LINKID,NODEID>
extends Object

"1D" implementation. Mapping on the design line (often the center line) of a road.

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.

$LastChangedDate: 2015-07-28 17:11:47 +0200 (Tue, 28 Jul 2015) $, @version $Revision: 1165 $, by $Author: averbraeck $, initial version Oct 22, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
LinkLocation(Link<LINKID,NODEID> link, double fractionalLongitudinalPosition)
LinkLocation(Link<LINKID,NODEID> link, DoubleScalar.Rel<LengthUnit> position)

Method Summary

Modifier and Type	Method and Description
DoubleScalar.Rel<LengthUnit>	distance(LinkLocation<LINKID,NODEID> loc) Returns the distance to another LinkLocation.
double	getFractionalLongitudinalPosition()
Link<LINKID,NODEID>	getLink()
DoubleScalar.Rel<LengthUnit>	getLongitudinalPosition()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkLocation

public LinkLocation(Link<LINKID,NODEID> link,
                    double fractionalLongitudinalPosition)

Parameters:

link - The link of the location of a point relative to the GTU.

fractionalLongitudinalPosition - The fractional position (between 0.0 and 1.0) of the reference point on the link.

LinkLocation

public LinkLocation(Link<LINKID,NODEID> link,
                    DoubleScalar.Rel<LengthUnit> position)

Parameters:

link - The link of the location of a point relative to the GTU.

position - The position as a length of the reference point on the link.

Method Detail

getLink

public final Link<LINKID,NODEID> getLink()

Returns:

lane.

getFractionalLongitudinalPosition

public final double getFractionalLongitudinalPosition()

Returns:

fractionalLongitudinalPosition.

getLongitudinalPosition

public final DoubleScalar.Rel<LengthUnit> getLongitudinalPosition()

Returns:

position as a length as a traveled length on this link.

distance

public final DoubleScalar.Rel<LengthUnit> distance(LinkLocation<LINKID,NODEID> loc)

Returns the distance to another LinkLocation. If the other location is in front of us, the distance is positive. If it is behind us, it is negative.

Parameters:

loc - the link location to find the distance to.

Returns:

the distance to another LinkLocation.

toString

public final String toString()

Overrides:

toString in class Object