org.opentrafficsim.core.gtu.generator

Class AbstractGTUGenerator<ID>

java.lang.Object

org.opentrafficsim.core.gtu.generator.AbstractGTUGenerator<ID>

Type Parameters:

ID - the ID type of the GTU (e.g., String or Integer)

Direct Known Subclasses:

GTUGeneratorIndividual

public abstract class AbstractGTUGenerator<ID>
extends Object

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

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<ID> gtuType, Class<?> gtuClass, GTUFollowingModel gtuFollowingModel, LaneChangeModel laneChangeModel, DistContinuousDoubleScalar.Abs<SpeedUnit> initialSpeedDist, DistContinuousDoubleScalar.Rel<TimeUnit> interarrivelTimeDist, long maxGTUs, DoubleScalar.Abs<TimeUnit> startTime, DoubleScalar.Abs<TimeUnit> endTime, Lane lane, RouteGenerator routeGenerator)

Method Summary

Modifier and Type	Method and Description
protected void	checkCarBuilderList() Check if car can be generated.
protected void	generate() Generate a GTU.
DoubleScalar.Abs<TimeUnit>	getEndTime()
Class<?>	getGtuClass()
GTUFollowingModel	getGtuFollowingModel()
GTUType<ID>	getGtuType()
DistContinuousDoubleScalar.Abs<SpeedUnit>	getInitialSpeedDist()
DistContinuousDoubleScalar.Rel<TimeUnit>	getInterarrivelTimeDist()
abstract DistContinuousDoubleScalar.Rel<LengthUnit>	getLengthDist()
long	getMaxGTUs()
abstract DistContinuousDoubleScalar.Abs<SpeedUnit>	getMaximumSpeedDist()
String	getName()
RouteGenerator	getRouteGenerator()
abstract OTSDEVSSimulatorInterface	getSimulator()
DoubleScalar.Abs<TimeUnit>	getStartTime()
abstract DistContinuousDoubleScalar.Rel<LengthUnit>	getWidthDist()
HeadwayGTU	headway(DoubleScalar.Rel<LengthUnit> maxDistance, Route route, Lane generatorLane) Check the available headway for GTU that is about to be constructed.
void	setRouteGenerator(RouteGenerator 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<ID> gtuType,
                            Class<?> gtuClass,
                            GTUFollowingModel gtuFollowingModel,
                            LaneChangeModel laneChangeModel,
                            DistContinuousDoubleScalar.Abs<SpeedUnit> initialSpeedDist,
                            DistContinuousDoubleScalar.Rel<TimeUnit> interarrivelTimeDist,
                            long maxGTUs,
                            DoubleScalar.Abs<TimeUnit> startTime,
                            DoubleScalar.Abs<TimeUnit> endTime,
                            Lane lane,
                            RouteGenerator routeGenerator)
                     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 -- at the end for now

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

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.

headway

public final HeadwayGTU headway(DoubleScalar.Rel<LengthUnit> maxDistance,
                                Route route,
                                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

route - Route; 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<LengthUnit> getLengthDist()

Returns:

lengthDist.

getWidthDist

public abstract DistContinuousDoubleScalar.Rel<LengthUnit> getWidthDist()

Returns:

widthDist.

getMaximumSpeedDist

public abstract DistContinuousDoubleScalar.Abs<SpeedUnit> getMaximumSpeedDist()

Returns:

maximumSpeedDist.

getName

public final String getName()

Returns:

name.

getGtuType

public final GTUType<ID> getGtuType()

Returns:

gtuType.

getGtuClass

public final Class<?> getGtuClass()

Returns:

gtuClass.

getGtuFollowingModel

public final GTUFollowingModel getGtuFollowingModel()

Returns:

gtuFollowingModel.

getInitialSpeedDist

public final DistContinuousDoubleScalar.Abs<SpeedUnit> getInitialSpeedDist()

Returns:

initialSpeedDist.

getInterarrivelTimeDist

public final DistContinuousDoubleScalar.Rel<TimeUnit> getInterarrivelTimeDist()

Returns:

interarrivelTimeDist.

getMaxGTUs

public final long getMaxGTUs()

Returns:

maxGTUs.

getStartTime

public final DoubleScalar.Abs<TimeUnit> getStartTime()

Returns:

startTime.

getEndTime

public final DoubleScalar.Abs<TimeUnit> getEndTime()

Returns:

endTime.

getRouteGenerator

public final RouteGenerator getRouteGenerator()

Returns:

routeGenerator.

setRouteGenerator

public final void setRouteGenerator(RouteGenerator routeGenerator)

Parameters:

routeGenerator - set routeGenerator.