Package org.opentrafficsim.road.gtu.generator.od

Class DefaultGTUCharacteristicsGeneratorOD

java.lang.Object

org.opentrafficsim.road.gtu.generator.od.DefaultGTUCharacteristicsGeneratorOD

All Implemented Interfaces:

GTUCharacteristicsGeneratorOD

public final class DefaultGTUCharacteristicsGeneratorOD
extends Object
implements GTUCharacteristicsGeneratorOD

Default generator for LaneBasedGTUCharacteristics.

Copyright (c) 2013-2022 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 10 dec. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultGTUCharacteristicsGeneratorOD.Factory	Factory for DefaultGTUCharacteristicsGeneratorOD.

Constructor Summary

Constructors

Constructor	Description
DefaultGTUCharacteristicsGeneratorOD()	Constructor using null-routes, default GTU characteristics and LMRS.
DefaultGTUCharacteristicsGeneratorOD(Set<TemplateGTUType> templates)	Constructor using null-routes, provided GTU templates and LMRS.
DefaultGTUCharacteristicsGeneratorOD(Set<TemplateGTUType> templates, StrategicalPlannerFactorySupplierOD factorySupplier)	Constructor using null-routes, provided GTU templates and provided strategical planner factory supplier.
DefaultGTUCharacteristicsGeneratorOD(Generator<GTUType> gtuTypeGenerator, RouteGeneratorOD routeGenerator, Set<TemplateGTUType> templates, StrategicalPlannerFactorySupplierOD factorySupplier)	Constructor using route supplier, provided GTU templates and provided strategical planner factory supplier.
DefaultGTUCharacteristicsGeneratorOD(StrategicalPlannerFactorySupplierOD factorySupplier)	Constructor using using null-routes, default GTU characteristics and provided GTU templates and provided strategical planner factory supplier.
DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeGenerator)	Constructor using route generator, default GTU characteristics and LMRS.
DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeSupplier, Set<TemplateGTUType> templates)	Constructor using route supplier, provided GTU templates and LMRS.
DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeGenerator, StrategicalPlannerFactorySupplierOD factorySupplier)	Constructor using route supplier, default GTU characteristics and provided strategical planner factory supplier.

Method Summary

Modifier and Type	Method	Description
LaneBasedGTUCharacteristics	draw(Node origin, Node destination, Category category, StreamInterface randomStream)	Generate new LaneBasedGTUCharacteristics using given input from OD.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD()

Constructor using null-routes, default GTU characteristics and LMRS.

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeGenerator)

Constructor using route generator, default GTU characteristics and LMRS.

Parameters:

routeGenerator - RouteGeneratorOD; route generator

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeSupplier,
                                            Set<TemplateGTUType> templates)

Constructor using route supplier, provided GTU templates and LMRS.

Parameters:

routeSupplier - RouteGeneratorOD; route supplier

templates - Set<TemplateGTUType>; templates

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(RouteGeneratorOD routeGenerator,
                                            StrategicalPlannerFactorySupplierOD factorySupplier)

Constructor using route supplier, default GTU characteristics and provided strategical planner factory supplier.

Parameters:

routeGenerator - RouteGeneratorOD; route generator

factorySupplier - StrategicalPlannerFactorySupplierOD; strategical factory supplier

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(Generator<GTUType> gtuTypeGenerator,
                                            RouteGeneratorOD routeGenerator,
                                            Set<TemplateGTUType> templates,
                                            StrategicalPlannerFactorySupplierOD factorySupplier)

Constructor using route supplier, provided GTU templates and provided strategical planner factory supplier.

Parameters:

gtuTypeGenerator - Generator<GTUType>; GTU type generator

routeGenerator - RouteGeneratorOD; route generator

templates - Set<TemplateGTUType>; templates

factorySupplier - StrategicalPlannerFactorySupplierOD; strategical factory supplier

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(Set<TemplateGTUType> templates)

Constructor using null-routes, provided GTU templates and LMRS.

Parameters:

templates - Set<TemplateGTUType>; templates

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(Set<TemplateGTUType> templates,
                                            StrategicalPlannerFactorySupplierOD factorySupplier)

Constructor using null-routes, provided GTU templates and provided strategical planner factory supplier.

Parameters:

templates - Set<TemplateGTUType>; templates

factorySupplier - StrategicalPlannerFactorySupplierOD; strategical factory supplier

DefaultGTUCharacteristicsGeneratorOD

public DefaultGTUCharacteristicsGeneratorOD(StrategicalPlannerFactorySupplierOD factorySupplier)

Constructor using using null-routes, default GTU characteristics and provided GTU templates and provided strategical planner factory supplier.

Parameters:

factorySupplier - StrategicalPlannerFactorySupplierOD; strategical factory supplier

Method Detail

draw

public LaneBasedGTUCharacteristics draw(Node origin,
                                        Node destination,
                                        Category category,
                                        StreamInterface randomStream)
                                 throws GTUException

Generate new LaneBasedGTUCharacteristics using given input from OD.

Specified by:

draw in interface GTUCharacteristicsGeneratorOD

Parameters:

origin - Node; origin

destination - Node; destination

category - Category; category (GTU type, route, or more)

randomStream - StreamInterface; stream for random numbers

Returns:

LaneBasedGTUCharacteristics

Throws:

GTUException - if characteristics could not be generated for the GTUException