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.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, org.opentrafficsim.core.network.route.RouteNavigator, org.opentrafficsim.core.OTS_SCALAR, 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR

org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Acceleration, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AnglePlane, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSlope, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSolid, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Area, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Density, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Dimensionless, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCharge, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCurrent, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalPotential, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalResistance, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Energy, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowMass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowVolume, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Force, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Frequency, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Length, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.LinearDensity, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Mass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Power, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Pressure, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Speed, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Temperature, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Time, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Torque, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Volume

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

Fields inherited from interface org.djunits.unit.UNITS

ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEG, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RAD, RADIAN, RPM, SECOND, SLOPE_ARCMINUTE, SLOPE_ARCSECOND, SLOPE_CENTESIMAL_ARCMINUTE, SLOPE_CENTESIMAL_ARCSECOND, SLOPE_DEGREE, SLOPE_GRAD, SLOPE_RADIAN, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

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, org.opentrafficsim.core.gtu.GTUType gtuType, 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,
                                                                     org.opentrafficsim.core.gtu.GTUType gtuType,
                                                                     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

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:

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