org.opentrafficsim.core.gtu.generator

Class AbstractGTUGenerator

java.lang.Object

org.opentrafficsim.core.gtu.generator.AbstractGTUGenerator

Direct Known Subclasses:

GTUGeneratorIndividual

public abstract class AbstractGTUGenerator
extends Object

Common code for LaneBasedGTU generators that may have to postpone putting a GTU on the road due to congestion growing into the generator.
Generally, these generators will discover that there is not enough room AFTER having decided what kind (particular length) of GTU will be constructed next. When this happens, the generator must remember the properties of the GTU, but postpone actual generation until there is enough room.

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: 1344 $, $LastChangedDate: 2015-08-30 13:16:27 +0200 (Sun, 30 Aug 2015) $, by $Author: averbraeck $, initial version Feb 2, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields

Modifier and Type	Field and Description
protected long	numberGTUs Number of generated GTUs.

Constructor Summary

Constructors

Constructor and Description

AbstractGTUGenerator(String name, OTSDEVSSimulatorInterface simulator, GTUType gtuType, Class<?> gtuClass, GTUFollowingModel gtuFollowingModel, LaneChangeModel laneChangeModel, DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeedDist, DistContinuousDoubleScalar.Rel<org.djunits.unit.TimeUnit> interarrivelTimeDist, long maxGTUs, org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> startTime, org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> endTime, Lane lane, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> position, LaneBasedRouteGenerator routeGenerator, GTUColorer gtuColorer)

Method Summary

Modifier and Type	Method and Description
protected void	checkCarBuilderList() Check if car can be generated.
protected boolean	enoughSpace(LaneBasedIndividualCar.LaneBasedIndividualCarBuilder carBuilder) Check if the car to be built is not overlapping with another GTU on the same lane, and if it has enough headway to be generated safely.
protected void	generate() Generate a GTU.
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>	getEndTime()
Class<?>	getGtuClass()
GTUColorer	getGtuColorer()
GTUFollowingModel	getGtuFollowingModel()
GTUType	getGtuType()
DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getInitialSpeedDist()
DistContinuousDoubleScalar.Rel<org.djunits.unit.TimeUnit>	getInterarrivelTimeDist()
LaneChangeModel	getLaneChangeModel()
abstract DistContinuousDoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLengthDist()
long	getMaxGTUs()
abstract DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getMaximumSpeedDist()
String	getName()
RouteGenerator	getRouteGenerator()
abstract OTSDEVSSimulatorInterface	getSimulator()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>	getStartTime()
abstract DistContinuousDoubleScalar.Rel<org.djunits.unit.LengthUnit>	getWidthDist()
HeadwayGTU	headway(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> maxDistance, LaneBasedRouteNavigator routeNavigator, Lane generatorLane) Check the available headway for GTU that is about to be constructed.
void	setRouteGenerator(LaneBasedRouteGenerator routeGenerator)

Methods inherited from class java.lang.Object

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

Field Detail

numberGTUs

protected long numberGTUs

Number of generated GTUs.

Constructor Detail

AbstractGTUGenerator

public AbstractGTUGenerator(String name,
                            OTSDEVSSimulatorInterface simulator,
                            GTUType gtuType,
                            Class<?> gtuClass,
                            GTUFollowingModel gtuFollowingModel,
                            LaneChangeModel laneChangeModel,
                            DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeedDist,
                            DistContinuousDoubleScalar.Rel<org.djunits.unit.TimeUnit> interarrivelTimeDist,
                            long maxGTUs,
                            org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> startTime,
                            org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> endTime,
                            Lane lane,
                            org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> position,
                            LaneBasedRouteGenerator routeGenerator,
                            GTUColorer gtuColorer)
                     throws RemoteException,
                            SimRuntimeException

Parameters:

name - the name of the generator

simulator - the simulator to schedule the start of the generation

gtuType - the type of GTU to generate

gtuClass - the GTU class to instantiate

gtuFollowingModel - the GTU following model to use

laneChangeModel - the lane change model to use

initialSpeedDist - distribution of the initial speed of the GTU

interarrivelTimeDist - distribution of the interarrival time

maxGTUs - maximum number of GTUs to generate

startTime - start time of generation (delayed start)

endTime - end time of generation

lane - the lane to generate the GTU on

position - position on the lane, relative to the design line of the link

routeGenerator - RouteGenerator; the route generator that will create a route for each generated GTU

gtuColorer - the GTUColorer to use

Throws:

SimRuntimeException - when simulation scheduling fails

RemoteException - when remote simulator cannot be reached

Method Detail

generate

protected final void generate()
                       throws Exception

Generate a GTU.

Throws:

Exception - when something in the generation fails.

enoughSpace

protected final boolean enoughSpace(LaneBasedIndividualCar.LaneBasedIndividualCarBuilder carBuilder)
                             throws RemoteException,
                                    NetworkException

Check if the car to be built is not overlapping with another GTU on the same lane, and if it has enough headway to be generated safely.

Parameters:

carBuilder - the car to be generated

Returns:

true if car can be safely built, false otherwise.

Throws:

RemoteException - if simulator cannot be reached to calculate current position

NetworkException - if GTU does not have a position on the lane where it is registered

headway

public final HeadwayGTU headway(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> maxDistance,
                                LaneBasedRouteNavigator routeNavigator,
                                Lane generatorLane)
                         throws RemoteException,
                                NetworkException

Check the available headway for GTU that is about to be constructed.

Parameters:

maxDistance - DoubleScalar.Rel<LengthUnit>; the maximum distance to look for a leader

routeNavigator - RouteNavigator; the route that this GTU intends to take

generatorLane - Lane; the lane on which the GTU is generated

Returns:

HeadwayGTU; the available headway and the GTU at that headway

Throws:

RemoteException - on communications failure

NetworkException - on network inconsistency

checkCarBuilderList

protected final void checkCarBuilderList()
                                  throws Exception

Check if car can be generated.

Throws:

Exception - on any problem

getSimulator

public abstract OTSDEVSSimulatorInterface getSimulator()

Returns:

simulator.

getLengthDist

public abstract DistContinuousDoubleScalar.Rel<org.djunits.unit.LengthUnit> getLengthDist()

Returns:

lengthDist.

getWidthDist

public abstract DistContinuousDoubleScalar.Rel<org.djunits.unit.LengthUnit> getWidthDist()

Returns:

widthDist.

getMaximumSpeedDist

public abstract DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit> getMaximumSpeedDist()

Returns:

maximumSpeedDist.

getName

public final String getName()

Returns:

name.

getGtuType

public final GTUType getGtuType()

Returns:

gtuType.

getGtuClass

public final Class<?> getGtuClass()

Returns:

gtuClass.

getGtuFollowingModel

public final GTUFollowingModel getGtuFollowingModel()

Returns:

gtuFollowingModel.

getInitialSpeedDist

public final DistContinuousDoubleScalar.Abs<org.djunits.unit.SpeedUnit> getInitialSpeedDist()

Returns:

initialSpeedDist.

getInterarrivelTimeDist

public final DistContinuousDoubleScalar.Rel<org.djunits.unit.TimeUnit> getInterarrivelTimeDist()

Returns:

interarrivelTimeDist.

getMaxGTUs

public final long getMaxGTUs()

Returns:

maxGTUs.

getStartTime

public final org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> getStartTime()

Returns:

startTime.

getEndTime

public final org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit> getEndTime()

Returns:

endTime.

getRouteGenerator

public final RouteGenerator getRouteGenerator()

Returns:

routeGenerator.

setRouteGenerator

public final void setRouteGenerator(LaneBasedRouteGenerator routeGenerator)

Parameters:

routeGenerator - set routeGenerator.

getLaneChangeModel

public final LaneChangeModel getLaneChangeModel()

Returns:

laneChangeModel.

getGtuColorer

public final GTUColorer getGtuColorer()

Returns:

gtuColorer.