org.opentrafficsim.road.network.route

Class AbstractLaneBasedRouteNavigator

java.lang.Object

org.opentrafficsim.road.network.route.AbstractLaneBasedRouteNavigator

All Implemented Interfaces:

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

Direct Known Subclasses:

CompleteLaneBasedRouteNavigator, RandomLaneBasedRouteNavigator

public abstract class AbstractLaneBasedRouteNavigator
extends Object
implements LaneBasedRouteNavigator, Serializable

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
static org.djunits.value.vdouble.scalar.Length.Rel	GETOFFTHISLANENOW Return value of suitability when a lane change is required right now.
static org.djunits.value.vdouble.scalar.Length.Rel	NOLANECHANGENEEDED Return value of suitability when no lane change is required withing the time horizon.

Constructor Summary

Constructors

Constructor and Description
AbstractLaneBasedRouteNavigator()

Method Summary

Modifier and Type	Method and Description
protected org.djunits.value.vdouble.scalar.Length.Rel	computeSuitabilityWithLaneChanges(Lane startLane, double remainingDistance, Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> suitabilities, int totalLanes, org.opentrafficsim.core.network.LateralDirectionality direction, org.opentrafficsim.core.gtu.GTUType gtuType) Compute the suitability of a lane from which lane changes are required to get to the next point on the Route. This method weighs the suitability of the nearest suitable lane by (m - n) / m where n is the number of lane changes required and m is the total number of lanes in the CrossSectionLink.
protected int	countCompatibleLanes(CrossSectionLink link, org.opentrafficsim.core.gtu.GTUType gtuType) Determine how many lanes on a CrossSectionLink are compatible with a particular GTU type. TODO: this method should probably be moved into the CrossSectionLink class

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.road.network.route.LaneBasedRouteNavigator

suitability

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

lastVisitedNode, nextNodeToVisit, visitNextNode

Field Detail

NOLANECHANGENEEDED

public static final org.djunits.value.vdouble.scalar.Length.Rel NOLANECHANGENEEDED

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

GETOFFTHISLANENOW

public static final org.djunits.value.vdouble.scalar.Length.Rel GETOFFTHISLANENOW

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

Constructor Detail

AbstractLaneBasedRouteNavigator

public AbstractLaneBasedRouteNavigator()

Method Detail

computeSuitabilityWithLaneChanges

protected final org.djunits.value.vdouble.scalar.Length.Rel computeSuitabilityWithLaneChanges(Lane startLane,
                                                                                              double remainingDistance,
                                                                                              Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> suitabilities,
                                                                                              int totalLanes,
                                                                                              org.opentrafficsim.core.network.LateralDirectionality direction,
                                                                                              org.opentrafficsim.core.gtu.GTUType gtuType)

Compute the suitability of a lane from which lane changes are required to get to the next point on the Route.
This method weighs the suitability of the nearest suitable lane by (m - n) / m where n is the number of lane changes required and m is the total number of lanes in the CrossSectionLink.

Parameters:

startLane - Lane; the current lane of the GTU

remainingDistance - double; distance in m of GTU to first branch

suitabilities - Map<Lane, Double>; the set of suitable lanes and their suitability

totalLanes - integer; total number of lanes compatible with the GTU type

direction - LateralDirectionality; the direction of the lane changes to attempt

gtuType - GTUType; the type of the GTU

Returns:

double; the suitability of the startLane for following the Route

countCompatibleLanes

protected final int countCompatibleLanes(CrossSectionLink link,
                                         org.opentrafficsim.core.gtu.GTUType gtuType)

Determine how many lanes on a CrossSectionLink are compatible with a particular GTU type.
TODO: this method should probably be moved into the CrossSectionLink class

Parameters:

link - CrossSectionLink; the link

gtuType - GTUType; the GTU type

Returns:

integer; the number of lanes on the link that are compatible with the GTU type