org.opentrafficsim.core.network.route

Class LaneBasedRouteNavigator

java.lang.Object

org.opentrafficsim.core.network.route.RouteNavigator

org.opentrafficsim.core.network.route.LaneBasedRouteNavigator

All Implemented Interfaces:

Serializable

public class LaneBasedRouteNavigator
extends RouteNavigator
implements Serializable

A RouteNavigator contains a complete route and maintains a position on the 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
static DoubleScalar.Rel<LengthUnit>	GETOFFTHISLANENOW Return value of suitability when a lane change is required right now.
static DoubleScalar.Rel<LengthUnit>	NOLANECHANGENEEDED Return value of suitability when no lane change is required withing the time horizon.

Fields inherited from class org.opentrafficsim.core.network.route.RouteNavigator

completeRoute, lastVisitedNodeIndex

Constructor Summary

Constructors

Constructor and Description
LaneBasedRouteNavigator(CompleteRoute<?,?> completeRoute) Create a navigator.

Method Summary

Modifier and Type	Method and Description
DoubleScalar.Rel<LengthUnit>	suitability(Lane<?,?> lane, DoubleScalar.Rel<LengthUnit> longitudinalPosition, GTUType<?> gtuType, DoubleScalar.Rel<TimeUnit> timeHorizon) Determine the suitability of being at a particular longitudinal position in a particular Lane for following this Route.

Methods inherited from class org.opentrafficsim.core.network.route.RouteNavigator

getRoute, lastVisitedNode, nextNodeToVisit, toString, visitNextNode

Methods inherited from class java.lang.Object

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

Field Detail

NOLANECHANGENEEDED

public static final DoubleScalar.Rel<LengthUnit> NOLANECHANGENEEDED

Return value of suitability when no lane change is required withing the time horizon.

GETOFFTHISLANENOW

public static final DoubleScalar.Rel<LengthUnit> GETOFFTHISLANENOW

Return value of suitability when a lane change is required right now.

Constructor Detail

LaneBasedRouteNavigator

public LaneBasedRouteNavigator(CompleteRoute<?,?> completeRoute)

Create a navigator.

Parameters:

completeRoute - the route to follow

Method Detail

suitability

public final DoubleScalar.Rel<LengthUnit> suitability(Lane<?,?> lane,
                                                      DoubleScalar.Rel<LengthUnit> longitudinalPosition,
                                                      GTUType<?> gtuType,
                                                      DoubleScalar.Rel<TimeUnit> timeHorizon)
                                               throws 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

gtuType - GTUType<?>; the type of the GTU (used to check lane compatibility of lanes)

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:

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