org.opentrafficsim.road.gtu.generator

Class LaneBasedGTUGenerator

java.lang.Object

org.opentrafficsim.road.gtu.generator.LaneBasedGTUGenerator

public class LaneBasedGTUGenerator
extends Object

Lane based GTU generator. This generator generates lane based GTUs using a LaneBasedTemplateGTUType. The template is used to generate a set of GTU characteristics at the times implied by the headway generator. These sets are queued until there is sufficient room to construct a GTU at the specified lane locations. The speed of a construction GTU may be reduced to ensure it does not run into its immediate leader GTU.

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.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Mar 8, 2016

Author:

Alexander Verbraeck, Peter Knoppers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LaneBasedGTUGenerator.RoomChecker Interface for class that checks that there is sufficient room for a proposed new GTU and returns the maximum safe speed for the proposed new GTU.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.opentrafficsim.core.gtu.animation.GTUColorer	gtuColorer The GTU colorer that will be linked to each generated GTU.
(package private) Set<DirectedLanePosition>	initialLongitudinalPositions The location and initial direction of the generated GTUs.
(package private) org.djunits.value.vdouble.scalar.Time.Rel	reTryInterval Retry interval for checking if a GTU can be placed.
(package private) LaneBasedGTUGenerator.RoomChecker	roomChecker The way that this generator checks if it is safe to construct and place the next lane based GTU.

Constructor Summary

Constructors

Constructor and Description

LaneBasedGTUGenerator(String id, org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Time.Rel> interarrivelTimeGenerator, long maxGTUs, org.djunits.value.vdouble.scalar.Time.Abs startTime, org.djunits.value.vdouble.scalar.Time.Abs endTime, org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer, LaneBasedGTUCharacteristicsGenerator laneBasedGTUCharacteristicsGenerator, Set<DirectedLanePosition> initialLongitudinalPositions, org.opentrafficsim.core.network.OTSNetwork network, LaneBasedGTUGenerator.RoomChecker roomChecker) Construct a new lane base GTU generator.

Method Summary

Modifier and Type	Method and Description
org.djunits.value.vdouble.scalar.Time.Abs	getEndTime() Retrieve the end time of this LaneBasedGTUGenerator.
long	getGeneratedGTUs()
org.opentrafficsim.core.gtu.animation.GTUColorer	getGtuColorer() Retrieve the GTUColorer that this LaneBasedGTUGenerator assigns to all generated GTUs.
String	getId() Retrieve the id of this LaneBasedGTUGenerator.
long	getMaxGTUs() Retrieve the maximum number of GTUs to generate.
void	setGeneratedGTUs(long generatedGTUs)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

reTryInterval

org.djunits.value.vdouble.scalar.Time.Rel reTryInterval

Retry interval for checking if a GTU can be placed.

initialLongitudinalPositions

final Set<DirectedLanePosition> initialLongitudinalPositions

The location and initial direction of the generated GTUs.

roomChecker

final LaneBasedGTUGenerator.RoomChecker roomChecker

The way that this generator checks if it is safe to construct and place the next lane based GTU.

gtuColorer

final org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer

The GTU colorer that will be linked to each generated GTU.

Constructor Detail

LaneBasedGTUGenerator

public LaneBasedGTUGenerator(String id,
                             org.opentrafficsim.core.distributions.Generator<org.djunits.value.vdouble.scalar.Time.Rel> interarrivelTimeGenerator,
                             long maxGTUs,
                             org.djunits.value.vdouble.scalar.Time.Abs startTime,
                             org.djunits.value.vdouble.scalar.Time.Abs endTime,
                             org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer,
                             LaneBasedGTUCharacteristicsGenerator laneBasedGTUCharacteristicsGenerator,
                             Set<DirectedLanePosition> initialLongitudinalPositions,
                             org.opentrafficsim.core.network.OTSNetwork network,
                             LaneBasedGTUGenerator.RoomChecker roomChecker)
                      throws nl.tudelft.simulation.dsol.SimRuntimeException,
                             org.opentrafficsim.core.distributions.ProbabilityException

Construct a new lane base GTU generator.

Parameters:

id - String; name of the new GTU generator

interarrivelTimeGenerator - Generator<Time.Rel>; generator for the interval times between GTUs

maxGTUs - long; maximum number of GTUs to generate

startTime - Time.Abs; time at which the first GTU will be generated

endTime - Time.Abs; time after which no more GTUs will be generated

gtuColorer - GTUColorer; the GTU colorer that will be used by all generated GTUs

laneBasedGTUCharacteristicsGenerator - LaneBasedGTUCharacteristicsGenerator; generator of the characteristics of each GTU

initialLongitudinalPositions - SET<DirectedLanePosition>; the location and initial direction of all generated GTUs

network - OTSNetwork; the OTS network that owns the generated GTUs

roomChecker - LaneBasedGTUGenerator.RoomChecker; the way that this generator checks that there is sufficient room to place a new GTU

Throws:

nl.tudelft.simulation.dsol.SimRuntimeException - when startTime lies before the current simulation time

org.opentrafficsim.core.distributions.ProbabilityException - pe

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getGeneratedGTUs

public long getGeneratedGTUs()

Returns:

generatedGTUs.

setGeneratedGTUs

public void setGeneratedGTUs(long generatedGTUs)

Parameters:

generatedGTUs - set generatedGTUs.

getId

public String getId()

Retrieve the id of this LaneBasedGTUGenerator.

Returns:

String; the id of this LaneBasedGTUGenerator

getEndTime

public org.djunits.value.vdouble.scalar.Time.Abs getEndTime()

Retrieve the end time of this LaneBasedGTUGenerator.

Returns:

Time.Abs; the time after which this LaneBasedGTUGenerator will not generate any more GTUs

getMaxGTUs

public long getMaxGTUs()

Retrieve the maximum number of GTUs to generate.

Returns:

long; once this number of GTUS is generated, this LaneBasedGTUGenerator will stop generating any more GTUs

getGtuColorer

public org.opentrafficsim.core.gtu.animation.GTUColorer getGtuColorer()

Retrieve the GTUColorer that this LaneBasedGTUGenerator assigns to all generated GTUs.

Returns:

GtuColorer; the GTUColorer that this LaneBasedGTUGenerator assigns to all generated GTUs