org.opentrafficsim.core.network.route

Class ProbabilisticRouteGenerator

java.lang.Object

org.opentrafficsim.core.network.route.ProbabilisticRouteGenerator

All Implemented Interfaces:

RouteGenerator

public class ProbabilisticRouteGenerator
extends Object
implements RouteGenerator

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-08-30 01:31:13 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1342 $, 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	ProbabilisticRouteGenerator.RouteProbability Combination of route and probability or frequency.

Constructor Summary

Constructors

Constructor and Description
ProbabilisticRouteGenerator(List<ProbabilisticRouteGenerator.RouteProbability> routeProbabilities, StreamInterface stream) Construct a new ProbabilistiRouteGenerator using the given random stream.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbabilisticRouteGenerator

public ProbabilisticRouteGenerator(List<ProbabilisticRouteGenerator.RouteProbability> routeProbabilities,
                                   StreamInterface stream)
                            throws NetworkException

Construct a new ProbabilistiRouteGenerator using the given random stream.

Parameters:

routeProbabilities - 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 CompleteRouteNavigator generateRouteNavigator()

Generate a RouteNavigator.

Specified by:

generateRouteNavigator in interface RouteGenerator

Returns:

RouteNavigator; the generated RouteNavigator