org.opentrafficsim.core.gtu

Interface GTU

All Superinterfaces:

nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable

All Known Subinterfaces:

LaneBasedGTU, SpaceBasedGTU

All Known Implementing Classes:

AbstractGTU, AbstractLaneBasedGTU, AbstractLaneBasedIndividualGTU, AbstractLaneBasedTemplateGTU, AbstractTrafficLight, LaneBasedIndividualCar, LaneBasedTemplateCar, LaneBlock, LaneBlockOnOff

public interface GTU
extends nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable

Generalized Travel Unit.
A GTU is an object (person, car, ship) that can travel over the infrastructure.

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: 1329 $, $LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

Method Summary

Modifier and Type	Method and Description
void	destroy() destroy the vehicle from the simulation and animation.
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.AccelerationUnit>	getAcceleration()
RelativePosition	getFront()
GTUType	getGTUType()
String	getId()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLength()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getMaximumVelocity()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.LengthUnit>	getOdometer() Retrieve the odometer value.
RelativePosition	getRear()
RelativePosition	getReference()
Map<RelativePosition.TYPE,RelativePosition>	getRelativePositions()
OTSDEVSSimulatorInterface	getSimulator()
org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit>	getVelocity()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getWidth()

Methods inherited from interface nl.tudelft.simulation.dsol.animation.LocatableInterface

getBounds, getLocation

Method Detail

getId

String getId()

Returns:

the id of the GTU

getLength

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLength()

Returns:

the maximum length of the GTU (parallel with driving direction).

getWidth

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getWidth()

Returns:

the maximum width of the GTU (perpendicular to driving direction).

getMaximumVelocity

org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> getMaximumVelocity()

Returns:

the maximum velocity of the GTU, in the linear direction

getGTUType

GTUType getGTUType()

Returns:

the type of GTU, e.g. TruckType, CarType, BusType

getSimulator

OTSDEVSSimulatorInterface getSimulator()

Returns:

the simulator of the GTU.

getReference

RelativePosition getReference()

Returns:

the reference position of the GTU, by definition (0, 0, 0).

getFront

RelativePosition getFront()

Returns:

the front position of the GTU, relative to its reference point.

getRear

RelativePosition getRear()

Returns:

the rear position of the GTU, relative to its reference point.

getVelocity

org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> getVelocity()
                                                                                   throws RemoteException

Returns:

the current velocity of the GTU, combining longitudinal, lateral and vertical speed components.

Throws:

RemoteException - on communications failure

getRelativePositions

Map<RelativePosition.TYPE,RelativePosition> getRelativePositions()

Returns:

the positions for this GTU.

destroy

void destroy()

destroy the vehicle from the simulation and animation.

getAcceleration

org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.AccelerationUnit> getAcceleration()
                                                                                              throws RemoteException

Returns:

the current acceleration of the GTU, combining longitudinal, lateral and vertical acceleration components.

Throws:

RemoteException - on communications failure

getOdometer

org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.LengthUnit> getOdometer()
                                                                                    throws RemoteException

Retrieve the odometer value.

Returns:

DoubleScalar.Abs<LengthUnit>; the current odometer value

Throws:

RemoteException - on communications failure