org.opentrafficsim.road.gtu.lane

Class LaneBasedTemplateGTUType

java.lang.Object

org.opentrafficsim.core.gtu.TemplateGTUType

org.opentrafficsim.road.gtu.lane.LaneBasedTemplateGTUType

All Implemented Interfaces:

Serializable, org.opentrafficsim.core.distributions.Generator<org.opentrafficsim.core.gtu.GTUCharacteristics>, LaneBasedGTUCharacteristicsGenerator

public class LaneBasedTemplateGTUType
extends org.opentrafficsim.core.gtu.TemplateGTUType
implements LaneBasedGTUCharacteristicsGenerator

Generate lane based GTUs using a template.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 29, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

LaneBasedTemplateGTUType(org.opentrafficsim.core.gtu.GTUType gtuType, org.opentrafficsim.core.idgenerator.IdGenerator idGenerator, org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator, org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator, org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, LaneBasedStrategicalPlannerFactory<?> strategicalPlannerFactory, org.opentrafficsim.core.network.route.RouteGenerator routeGenerator, Set<DirectedLanePosition> initialLongitudinalPositions, org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Speed> initialSpeedGenerator, org.opentrafficsim.core.network.OTSNetwork network)

Method Summary

Modifier and Type	Method and Description
LaneBasedGTUCharacteristics	draw() Generate the properties of the next GTU.
String	toString()

Methods inherited from class org.opentrafficsim.core.gtu.TemplateGTUType

getGTUType, getIdGenerator, getSimulator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.road.gtu.lane.LaneBasedGTUCharacteristicsGenerator

getSimulator

Constructor Detail

LaneBasedTemplateGTUType

public LaneBasedTemplateGTUType(org.opentrafficsim.core.gtu.GTUType gtuType,
                                org.opentrafficsim.core.idgenerator.IdGenerator idGenerator,
                                org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator,
                                org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator,
                                org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator,
                                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                                LaneBasedStrategicalPlannerFactory<?> strategicalPlannerFactory,
                                org.opentrafficsim.core.network.route.RouteGenerator routeGenerator,
                                Set<DirectedLanePosition> initialLongitudinalPositions,
                                org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Speed> initialSpeedGenerator,
                                org.opentrafficsim.core.network.OTSNetwork network)
                         throws NullPointerException

Parameters:

gtuType - The GTUType to make it identifiable.

idGenerator - IdGenerator; the id generator used to generate names for GTUs constructed using this TemplateGTUType. Provide null to use the default id generator of AbstractGTU.

lengthGenerator - Generator<Length> generator for the length of the GTU type (parallel with driving direction).

widthGenerator - Generator<Length>; generator for the width of the GTU type (perpendicular to driving direction).

maximumSpeedGenerator - Generator<Speed>; generator for the maximum speed of the GTU type (in the driving direction).

simulator - the simulator.

strategicalPlannerFactory - Factory for the strategical planner (e.g., route determination)

routeGenerator - route generator

initialLongitudinalPositions - Set<DirectedLanePosition>; the initial lanes, directions and positions of generated GTUs

initialSpeedGenerator - Generator<Speed>; the generator for the initial speed of generated GTUs

network - OTSNetwork; the network that all generated GTUs are registered in

Throws:

NullPointerException - when one or more parameters are null

Method Detail

draw

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

Generate the properties of the next GTU.

Specified by:

draw in interface org.opentrafficsim.core.distributions.Generator<org.opentrafficsim.core.gtu.GTUCharacteristics>

Specified by:

draw in interface LaneBasedGTUCharacteristicsGenerator

Overrides:

draw in class org.opentrafficsim.core.gtu.TemplateGTUType

Returns:

the LaneBasedGTUCharacteristics with a drawn perception, strategical planner, and initial speed.

Throws:

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

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

toString

public String toString()

Overrides:

toString in class org.opentrafficsim.core.gtu.TemplateGTUType