org.opentrafficsim.core.network.route

Class ProbabilisticLaneBasedRouteGenerator

java.lang.Object

org.opentrafficsim.core.network.route.ProbabilisticLaneBasedRouteGenerator

All Implemented Interfaces:

LaneBasedRouteGenerator, RouteGenerator

public class ProbabilisticLaneBasedRouteGenerator
extends Object
implements LaneBasedRouteGenerator

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-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $, initial version 20 Mar 2015

Author:

Alexander Verbraeck, Peter Knoppers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProbabilisticLaneBasedRouteGenerator.LaneBasedRouteProbability Combination of route and probability or frequency.

Constructor Summary

Constructors

Constructor and Description
ProbabilisticLaneBasedRouteGenerator(List<ProbabilisticLaneBasedRouteGenerator.LaneBasedRouteProbability> laneBasedRouteProbabilities, StreamInterface stream) Construct a new ProbabilistiRouteGenerator using the given random stream.

Method Summary

Modifier and Type	Method and Description
LaneBasedRouteNavigator	generateRouteNavigator() Generate a RouteNavigator.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbabilisticLaneBasedRouteGenerator

public ProbabilisticLaneBasedRouteGenerator(List<ProbabilisticLaneBasedRouteGenerator.LaneBasedRouteProbability> laneBasedRouteProbabilities,
                                            StreamInterface stream)
                                     throws NetworkException

Construct a new ProbabilistiRouteGenerator using the given random stream.

Parameters:

laneBasedRouteProbabilities - the Routes with the probabilities for each one. Instead of probabilities, (observed) frequencies may be used; i.e. the provided values are internally scaled to add up to 1.0.

stream - the random stream to use

Throws:

NetworkException - when the probabilities or frequencies are invalid (negative, or all zero)

Method Detail

generateRouteNavigator

public final LaneBasedRouteNavigator generateRouteNavigator()

Generate a RouteNavigator.

Specified by:

generateRouteNavigator in interface LaneBasedRouteGenerator

Specified by:

generateRouteNavigator in interface RouteGenerator

Returns:

RouteNavigator; the generated RouteNavigator, lane-based