org.opentrafficsim.road.gtu.generator

Class LaneBasedGTUGenerator

java.lang.Object

org.opentrafficsim.road.gtu.generator.LaneBasedGTUGenerator

All Implemented Interfaces:

Serializable, Locatable, Identifiable, GTUGenerator

public class LaneBasedGTUGenerator
extends Object
implements Serializable, Identifiable, GTUGenerator

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-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 Mar 8, 2016

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LaneBasedGTUGenerator.Placement Placement contains the information that a RoomChecker returns.
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 and position for the proposed new GTU.

Constructor Summary

Constructors

Constructor and Description
LaneBasedGTUGenerator(String id, Generator<Duration> interarrivelTimeGenerator, GTUColorer gtuColorer, LaneBasedGTUCharacteristicsGenerator laneBasedGTUCharacteristicsGenerator, GeneratorPositions generatorPositions, OTSNetwork network, DEVSSimulatorInterface.TimeDoubleUnit simulator, LaneBasedGTUGenerator.RoomChecker roomChecker, IdGenerator idGenerator) Construct a new lane base GTU generator.

Method Summary

Modifier and Type	Method and Description
void	disable(Time start, Time end, Set<LaneDirection> laneDirections) Disable the vehicle generator during the specific time.
javax.media.j3d.Bounds	getBounds()
long	getGeneratedGTUs()
GTUColorer	getGtuColorer() Retrieve the GTUColorer that this LaneBasedGTUGenerator assigns to all generated GTUs.
String	getId() Retrieve the id of this LaneBasedGTUGenerator.
DirectedPoint	getLocation()
Map<DirectedPoint,Integer>	getQueueLengths() Returns the number of vehicles in queue per included position for animation.
void	setGeneratedGTUs(long generatedGTUs)
void	setNoLaneChangeDistance(Length noLaneChangeDistance) Sets the initial distance over which lane changes shouldn't be performed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneBasedGTUGenerator

public LaneBasedGTUGenerator(String id,
                             Generator<Duration> interarrivelTimeGenerator,
                             GTUColorer gtuColorer,
                             LaneBasedGTUCharacteristicsGenerator laneBasedGTUCharacteristicsGenerator,
                             GeneratorPositions generatorPositions,
                             OTSNetwork network,
                             DEVSSimulatorInterface.TimeDoubleUnit simulator,
                             LaneBasedGTUGenerator.RoomChecker roomChecker,
                             IdGenerator idGenerator)
                      throws SimRuntimeException,
                             ProbabilityException,
                             ParameterException

Construct a new lane base GTU generator.

Parameters:

id - String; name of the new GTU generator

interarrivelTimeGenerator - Generator<Duration>; generator for the interval times between GTUs

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

laneBasedGTUCharacteristicsGenerator - LaneBasedGTUCharacteristicsGenerator; generator of the characteristics of each GTU

generatorPositions - GeneratorPositions; location and initial direction provider for all generated GTUs

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

simulator - DEVSSimulatorInterface.TimeDoubleUnit; simulator

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

idGenerator - IdGenerator; id generator

Throws:

SimRuntimeException - when startTime lies before the current simulation time

ProbabilityException - pe

ParameterException - if drawing from the interarrival generator fails

Method Detail

setNoLaneChangeDistance

public void setNoLaneChangeDistance(Length noLaneChangeDistance)

Sets the initial distance over which lane changes shouldn't be performed.

Parameters:

noLaneChangeDistance - Length; initial distance over which lane changes shouldn't be performed

toString

public final String toString()

Overrides:

toString in class Object

getGeneratedGTUs

public final long getGeneratedGTUs()

Returns:

generatedGTUs.

setGeneratedGTUs

public final void setGeneratedGTUs(long generatedGTUs)

Parameters:

generatedGTUs - set generatedGTUs.

getId

public final String getId()

Retrieve the id of this LaneBasedGTUGenerator.

Specified by:

getId in interface Identifiable

Returns:

String; the id of this LaneBasedGTUGenerator

getGtuColorer

public final 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

disable

public void disable(Time start,
                    Time end,
                    Set<LaneDirection> laneDirections)
             throws SimRuntimeException

Disable the vehicle generator during the specific time. Underlying processes such as drawing characteristics and headways are continued, but simply will not result in the actual generation of a GTU.

Parameters:

start - Time; start time

end - Time; end time

laneDirections - Set<LaneDirection>; lanes to disable generation on

Throws:

SimRuntimeException - if time is incorrect

getLocation

public DirectedPoint getLocation()
                          throws RemoteException

Specified by:

getLocation in interface Locatable

Throws:

RemoteException

getBounds

public javax.media.j3d.Bounds getBounds()
                                 throws RemoteException

Specified by:

getBounds in interface Locatable

Throws:

RemoteException

getQueueLengths

public Map<DirectedPoint,Integer> getQueueLengths()

Returns the number of vehicles in queue per included position for animation.

Specified by:

getQueueLengths in interface GTUGenerator

Returns:

number of vehicles in queue per included position for animation