org.opentrafficsim.core.network.route

Class CompleteLaneBasedRouteNavigator

java.lang.Object

org.opentrafficsim.core.network.route.AbstractLaneBasedRouteNavigator

org.opentrafficsim.core.network.route.CompleteLaneBasedRouteNavigator

All Implemented Interfaces:

Serializable, LaneBasedRouteNavigator, RouteNavigator

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 CompleteRoute	completeRoute The complete route.
protected int	lastVisitedNodeIndex last visited node on the route.

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

GETOFFTHISLANENOW, NOLANECHANGENEEDED

Constructor Summary

Constructors

Constructor and Description
CompleteLaneBasedRouteNavigator(CompleteRoute completeRoute) Create a navigator.

Method Summary

Modifier and Type	Method and Description
CompleteRoute	getRoute()
Node	lastVisitedNode()
Node	nextNodeToVisit() This method does not advance the route pointer.
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.
String	toString()
Node	visitNextNode() This method does advance the route pointer (if possible).

Methods inherited from class org.opentrafficsim.core.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 CompleteRoute completeRoute

The complete route.

lastVisitedNodeIndex

protected int lastVisitedNodeIndex

last visited node on the route.

Constructor Detail

CompleteLaneBasedRouteNavigator

public CompleteLaneBasedRouteNavigator(CompleteRoute completeRoute)

Create a navigator.

Parameters:

completeRoute - the route to follow

Method Detail

lastVisitedNode

public final Node lastVisitedNode()
                           throws NetworkException

Returns:

the last visited node of the route, and null when no nodes have been visited yet.

Throws:

NetworkException - when the index is out of bounds (should never happen).

nextNodeToVisit

public final Node nextNodeToVisit()
                           throws NetworkException

This method does not advance the route pointer.

Returns:

the next node of the route to visit, and null when we already reached the destination.

Throws:

NetworkException - when the index is out of bounds (should never happen).

visitNextNode

public final Node visitNextNode()
                         throws NetworkException

This method does advance the route pointer (if possible).

Returns:

the next node of the route to visit, and null when we already reached the destination.

Throws:

NetworkException - when the index is out of bounds (should never happen).

suitability

public final 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

getRoute

public final CompleteRoute getRoute()

Returns:

the (complete) route.

toString

public String toString()

Overrides:

toString in class Object