org.opentrafficsim.road.gtu.generator

Class CharacteristicsGenerator

java.lang.Object

org.opentrafficsim.road.gtu.generator.CharacteristicsGenerator

All Implemented Interfaces:

LaneBasedGTUCharacteristicsGenerator

public class CharacteristicsGenerator
extends Object
implements LaneBasedGTUCharacteristicsGenerator

Copyright (c) 2013-2017 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 16 nov. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description

CharacteristicsGenerator(LaneBasedStrategicalRoutePlannerFactory strategicalFactory, org.opentrafficsim.core.network.route.RouteGenerator routeGenerator, org.opentrafficsim.core.idgenerator.IdGenerator idGenerator, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.network.OTSNetwork network, GTUTypeGenerator gtuTypeGenerator, org.djunits.value.vdouble.scalar.Speed generationSpeed, Set<DirectedLanePosition> positions)

Method Summary

Modifier and Type	Method and Description
LaneBasedGTUCharacteristics	draw() Generate a LaneBasedGTUCharacteristics object.
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	getSimulator() Return the simulator.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacteristicsGenerator

public CharacteristicsGenerator(LaneBasedStrategicalRoutePlannerFactory strategicalFactory,
                                org.opentrafficsim.core.network.route.RouteGenerator routeGenerator,
                                org.opentrafficsim.core.idgenerator.IdGenerator idGenerator,
                                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                                org.opentrafficsim.core.network.OTSNetwork network,
                                GTUTypeGenerator gtuTypeGenerator,
                                org.djunits.value.vdouble.scalar.Speed generationSpeed,
                                Set<DirectedLanePosition> positions)

Parameters:

strategicalFactory - strategical planner factory

routeGenerator - route generator

idGenerator - generator for the GTU id

simulator - the simulator

network - the network

gtuTypeGenerator - the generator for the GTU type

generationSpeed - the initial speed

positions - the positions for generation

Method Detail

draw

public LaneBasedGTUCharacteristics draw()
                                 throws org.opentrafficsim.core.distributions.ProbabilityException,
                                        org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                        org.opentrafficsim.core.gtu.GTUException

Generate a LaneBasedGTUCharacteristics object.

Specified by:

draw in interface LaneBasedGTUCharacteristicsGenerator

Returns:

LaneBasedGTUCharacteristics

Throws:

org.opentrafficsim.core.distributions.ProbabilityException - when the generator is improperly configured

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - in case of a parameter problem.

org.opentrafficsim.core.gtu.GTUException - if strategical planner cannot be created

getSimulator

public org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()
                                                                    throws org.opentrafficsim.core.distributions.ProbabilityException

Return the simulator.

Specified by:

getSimulator in interface LaneBasedGTUCharacteristicsGenerator

Returns:

OTSDEVSSimulatorInterface; the simulator

Throws:

org.opentrafficsim.core.distributions.ProbabilityException - when the generator cannot retrieve the simulator