org.opentrafficsim.road.network.route

Class CompleteLaneBasedRouteNavigator

java.lang.Object

org.opentrafficsim.road.network.route.AbstractLaneBasedRouteNavigator

org.opentrafficsim.road.network.route.CompleteLaneBasedRouteNavigator

All Implemented Interfaces:

Serializable, org.opentrafficsim.core.network.route.RouteNavigator, LaneBasedRouteNavigator

public class CompleteLaneBasedRouteNavigator
extends AbstractLaneBasedRouteNavigator

A RouteNavigator helps to navigate on a route. In addition, helper methods are available to see if the GTU needs to change lanes to reach the next link on the route.

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-16 10:20:53 +0200 (Thu, 16 Jul 2015) $, @version $Revision: 1124 $, by $Author: pknoppers $, initial version Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opentrafficsim.core.network.route.CompleteRoute	completeRoute The complete route.
protected int	lastVisitedNodeIndex last visited node on the route.

Fields inherited from class org.opentrafficsim.road.network.route.AbstractLaneBasedRouteNavigator

GETOFFTHISLANENOW, NOLANECHANGENEEDED

Constructor Summary

Constructors

Constructor and Description
CompleteLaneBasedRouteNavigator(org.opentrafficsim.core.network.route.CompleteRoute completeRoute) Create a navigator.

Method Summary

Modifier and Type	Method and Description
org.opentrafficsim.core.network.route.CompleteRoute	getRoute()
org.opentrafficsim.core.network.Node	lastVisitedNode()
org.opentrafficsim.core.network.Node	nextNodeToVisit()
org.djunits.value.vdouble.scalar.Length.Rel	suitability(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition, LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Time.Rel timeHorizon) Determine the suitability of being at a particular longitudinal position in a particular Lane for following this Route.
String	toString()
org.opentrafficsim.core.network.Node	visitNextNode()

Methods inherited from class org.opentrafficsim.road.network.route.AbstractLaneBasedRouteNavigator

computeSuitabilityWithLaneChanges, countCompatibleLanes

Methods inherited from class java.lang.Object

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

Field Detail

completeRoute

protected final org.opentrafficsim.core.network.route.CompleteRoute completeRoute

The complete route.

lastVisitedNodeIndex

protected int lastVisitedNodeIndex

last visited node on the route.

Constructor Detail

CompleteLaneBasedRouteNavigator

public CompleteLaneBasedRouteNavigator(org.opentrafficsim.core.network.route.CompleteRoute completeRoute)

Create a navigator.

Parameters:

completeRoute - the route to follow

Method Detail

lastVisitedNode

public final org.opentrafficsim.core.network.Node lastVisitedNode()
                                                           throws org.opentrafficsim.core.network.NetworkException

Throws:

org.opentrafficsim.core.network.NetworkException

nextNodeToVisit

public final org.opentrafficsim.core.network.Node nextNodeToVisit()
                                                           throws org.opentrafficsim.core.network.NetworkException

Throws:

org.opentrafficsim.core.network.NetworkException

visitNextNode

public final org.opentrafficsim.core.network.Node visitNextNode()
                                                         throws org.opentrafficsim.core.network.NetworkException

Throws:

org.opentrafficsim.core.network.NetworkException

suitability

public final org.djunits.value.vdouble.scalar.Length.Rel suitability(Lane lane,
                                                                     org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition,
                                                                     LaneBasedGTU gtu,
                                                                     org.djunits.value.vdouble.scalar.Time.Rel timeHorizon)
                                                              throws org.opentrafficsim.core.network.NetworkException

Determine the suitability of being at a particular longitudinal position in a particular Lane for following this Route.

Parameters:

lane - Lane; the lane to consider

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the longitudinal position in the lane

gtu - GTU; the GTU (used to check lane compatibility of lanes, and current lane the GTU is on)

timeHorizon - DoubleScalar.Rel<TimeUnit>; the maximum time that a driver may want to look ahead

Returns:

DoubleScalar.Rel<LengthUnit>; a value that indicates within what distance the GTU should try to vacate this lane.

Throws:

org.opentrafficsim.core.network.NetworkException - on network inconsistency, or when the continuation Link at a branch cannot be determined

getRoute

public final org.opentrafficsim.core.network.route.CompleteRoute getRoute()

Returns:

the (complete) route.

toString

public String toString()

Overrides:

toString in class Object