org.opentrafficsim.core.network.route

Interface LaneBasedRouteNavigator

All Superinterfaces:

RouteNavigator, Serializable

All Known Implementing Classes:

AbstractLaneBasedRouteNavigator, CompleteLaneBasedRouteNavigator

public interface LaneBasedRouteNavigator
extends RouteNavigator

The LaneBasedRouteNavigator interface defines 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

Method Summary

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

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

lastVisitedNode, nextNodeToVisit, visitNextNode

Method Detail

suitability

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> suitability(Lane lane,
                                                                                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> longitudinalPosition,
                                                                                           GTUType gtuType,
                                                                                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.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