org.opentrafficsim.road.gtu.strategical.route

Interface RouteSupplier

All Known Implementing Classes:

RouteSupplier.DefaultRouteSupplier

public interface RouteSupplier

Supplies a route by determining one.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 24 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RouteSupplier.DefaultRouteSupplier Shortest route route supplier.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<StreamInterface,RouteSupplier>	DEFAULT_MAP Cache of default route suppliers per stream.
static RouteSupplier	NULL No route route supplier.

Method Summary

Modifier and Type	Method and Description
static RouteSupplier	getDefaultRouteSupplier(StreamInterface stream) Returns a default route supplier for shortest routes based on the given stream.
Route	getRoute(Node origin, Node destination, GTUType gtuType) Returns a route.

Field Detail

NULL

static final RouteSupplier NULL

No route route supplier.

DEFAULT_MAP

static final Map<StreamInterface,RouteSupplier> DEFAULT_MAP

Cache of default route suppliers per stream.

Method Detail

getDefaultRouteSupplier

static RouteSupplier getDefaultRouteSupplier(StreamInterface stream)

Returns a default route supplier for shortest routes based on the given stream.

Parameters:

stream - StreamInterface; random number stream

Returns:

RouteSupplier; default route supplier for shortest routes based on the given stream

getRoute

Route getRoute(Node origin,
               Node destination,
               GTUType gtuType)

Returns a route.

Parameters:

origin - Node; origin

destination - Node; destination

gtuType - GTUType; gtu type

Returns:

Route; route