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-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version Jul 8, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TemplateGTUType(GTUType gtuType, Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator, Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator, Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator)
TemplateGTUType(GTUType gtuType, Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator, Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator, Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator, Generator<org.djunits.value.vdouble.scalar.Acceleration> maximumAccelerationGenerator, Generator<org.djunits.value.vdouble.scalar.Acceleration> maximumDecelerationGenerator)

Method Summary

Modifier and Type	Method and Description
GTUCharacteristics	draw() Returns characteristics for the given GTU.
GTUType	getGTUType()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateGTUType

public TemplateGTUType(GTUType gtuType,
                       Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator)
                throws NullPointerException

Parameters:

gtuType - GTUType, the GTUType to make it identifiable.

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

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

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

Throws:

NullPointerException - when one of the arguments is null

TemplateGTUType

public TemplateGTUType(GTUType gtuType,
                       Generator<org.djunits.value.vdouble.scalar.Length> lengthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Length> widthGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Speed> maximumSpeedGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Acceleration> maximumAccelerationGenerator,
                       Generator<org.djunits.value.vdouble.scalar.Acceleration> maximumDecelerationGenerator)
                throws NullPointerException

Parameters:

gtuType - GTUType, the GTUType to make it identifiable.

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

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

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

maximumAccelerationGenerator - Generator<Acceleration>; generator for the maximum acceleration of the GTU type

maximumDecelerationGenerator - Generator<Acceleration>; generator for the maximum deceleration of the GTU type

Throws:

NullPointerException - when one of the arguments is null

Method Detail

draw

public GTUCharacteristics draw()
                        throws ProbabilityException,
                               org.opentrafficsim.base.parameters.ParameterException

Returns characteristics for the given GTU.

Specified by:

draw in interface Generator<GTUCharacteristics>

Returns:

characteristics for the given GTU

Throws:

ProbabilityException - in case of probability exception

org.opentrafficsim.base.parameters.ParameterException - in case of parameter exception

getGTUType

public GTUType getGTUType()

Returns:

gtuType.

toString

public String toString()

Overrides:

toString in class Object