org.opentrafficsim.core.gtu

Class TemplateGTUType

java.lang.Object

org.opentrafficsim.core.gtu.TemplateGTUType

All Implemented Interfaces:

Serializable, Generator<GTUCharacteristics>

public class TemplateGTUType
extends Object
implements Serializable, Generator<GTUCharacteristics>

TemplateGTUType stores most of the information that is needed to generate a 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.

$LastChangedDate: 2016-04-05 01:45:04 +0200 (Tue, 05 Apr 2016) $, @version $Revision: 1874 $, by $Author: pknoppers $, initial version Jul 8, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TemplateGTUType(String typeId, IdGenerator idGenerator, Generator<org.djunits.value.vdouble.scalar.Length.Rel> lengthGenerator, Generator<org.djunits.value.vdouble.scalar.Length.Rel> widthGenerator, Generator<org.djunits.value.vdouble.scalar.Speed> maximumVelocityGenerator, OTSDEVSSimulatorInterface simulator, OTSNetwork network)

Method Summary

Modifier and Type	Method and Description
GTUCharacteristics	draw() Generate the next object.
GTUType	getGTUType()
IdGenerator	getIdGenerator() Retrieve the id generator.
OTSDEVSSimulatorInterface	getSimulator()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateGTUType

public TemplateGTUType(String typeId,
                       IdGenerator idGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Length.Rel> lengthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Length.Rel> widthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Speed> maximumVelocityGenerator,
                       OTSDEVSSimulatorInterface simulator,
                       OTSNetwork network)
                throws GTUException

Parameters:

typeId - String, the id of the GTUType to make it identifiable.

idGenerator - IdGenerator; the id generator used to generate names for GTUs constructed using this TemplateGTUType. Provide null to use the default id generator of AbstractGTU.

lengthGenerator - Generator<Length.Rel>; generator for the length of the GTU type (parallel with driving direction).

widthGenerator - Generator<Length.Rel>; generator for the width of the GTU type (perpendicular to driving direction).

maximumVelocityGenerator - Generator<Speed>; generator for the maximum velocity of the GTU type (in the driving direction).

simulator - OTSDEVSSimulatorInterface; the simulator.

network - OTSNetwork; the network that will own the GTUs

Throws:

GTUException - when one or more arguments are invalid

Method Detail

draw

public GTUCharacteristics draw()
                        throws ProbabilityException

Generate the next object.

Specified by:

draw in interface Generator<GTUCharacteristics>

Returns:

O; an object randomly selected from the stored collection

Throws:

ProbabilityException - if the stored collection is empty

getIdGenerator

public final IdGenerator getIdGenerator()

Retrieve the id generator.

Returns:

IdGenerator

getSimulator

public final OTSDEVSSimulatorInterface getSimulator()

Returns:

simulator.

getGTUType

public GTUType getGTUType()

Returns:

gtuType.

toString

public String toString()

Overrides:

toString in class Object