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<GTU<ID>> gtuClass, GTUFollowingModel gtuFollowingModel, DistContinuousDoubleScalar.Abs<SpeedUnit> initialSpeedDist, DistContinuousDoubleScalar.Rel<TimeUnit> interarrivelTimeDist, long maxGTUs, OTSSimTimeDouble startTime, OTSSimTimeDouble endTime, Lane lane)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generate() Generate a GTU.
OTSSimTimeDouble	getEndTime()
Class<GTU<ID>>	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()
abstract OTSDEVSSimulatorInterface	getSimulator()
OTSSimTimeDouble	getStartTime()
abstract DistContinuousDoubleScalar.Rel<LengthUnit>	getWidthDist()

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<GTU<ID>> gtuClass,
                    GTUFollowingModel gtuFollowingModel,
                    DistContinuousDoubleScalar.Abs<SpeedUnit> initialSpeedDist,
                    DistContinuousDoubleScalar.Rel<TimeUnit> interarrivelTimeDist,
                    long maxGTUs,
                    OTSSimTimeDouble startTime,
                    OTSSimTimeDouble endTime,
                    Lane lane)
                     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.

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.

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

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<GTU<ID>> 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 OTSSimTimeDouble getStartTime()

Returns:

startTime.

getEndTime

public final OTSSimTimeDouble getEndTime()

Returns:

endTime.