GTU (Open Traffic Sim core classes 0.05.00-SNAPSHOT API)

All Superinterfaces:

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

All Known Subinterfaces:

SpaceBasedGTU

All Known Implementing Classes:

AbstractGTU, AbstractLinkBasedGTU
```
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. It has a (directed) location, dimensions, and some properties that all GTUs share. The GTU is not bound to any infrastructure and can travel freely in the world.
For its movement, a GTU uses an OperationalPlan, which indicates a shape in the world with a speed profile that the GTU will use to move. The OperationalPlan can be updated or replaced, for which a tactical planner is responsible. A tactical plan can for instance be for a car to change two lanes to the left during the next 200 m to be able to make a left turn in 200 m. The operational plans are then the implementation of segments of the movement (time, location, speed, acceleration) that the car will make to drive on the road and (safely) make the lane changes. On the highest level, a StrategicPlan puts boundary conditions on the tactical plans. The strategic plan contains for instance the destination we want to reach and possibly some constraints on solutions that the tactical plans have to comply with.
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: 1668 $, $LastChangedDate: 2015-12-29 03:56:14 +0100 (Tue, 29 Dec 2015) $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`destroy()` destroy the GTU from the simulation and animation.
`org.djunits.value.vdouble.scalar.Acceleration`	`getAcceleration()`
`org.djunits.value.vdouble.scalar.Acceleration`	`getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs time)`
`javax.media.j3d.Bounds`	`getBounds()`
`DrivingCharacteristics`	`getDrivingCharacteristics()`
`RelativePosition`	`getFront()`
`GTUType`	`getGTUType()`
`String`	`getId()`
`org.djunits.value.vdouble.scalar.Length.Rel`	`getLength()`
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocation()`
`org.djunits.value.vdouble.scalar.Acceleration`	`getMaximumAcceleration()`
`org.djunits.value.vdouble.scalar.Acceleration`	`getMaximumDeceleration()`
`org.djunits.value.vdouble.scalar.Speed`	`getMaximumVelocity()`
`org.djunits.value.vdouble.scalar.Length.Rel`	`getOdometer()`
`OperationalPlan`	`getOperationalPlan()`
`Perception`	`getPerception()`
`RelativePosition`	`getRear()`
`RelativePosition`	`getReference()`
`Map<RelativePosition.TYPE,RelativePosition>`	`getRelativePositions()`
`OTSDEVSSimulatorInterface`	`getSimulator()`
`StrategicalPlanner`	`getStrategicalPlanner()`
`TacticalPlanner`	`getTacticalPlanner()`
`org.djunits.value.vdouble.scalar.Speed`	`getVelocity()`
`org.djunits.value.vdouble.scalar.Speed`	`getVelocity(org.djunits.value.vdouble.scalar.Time.Abs time)`
`org.djunits.value.vdouble.scalar.Length.Rel`	`getWidth()`

- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    the id of the GTU
  - getLength
```
org.djunits.value.vdouble.scalar.Length.Rel getLength()
```
    Returns:
    
    the maximum length of the GTU (parallel with driving direction).
  - getWidth
```
org.djunits.value.vdouble.scalar.Length.Rel getWidth()
```
    Returns:
    
    the maximum width of the GTU (perpendicular to driving direction).
  - getMaximumVelocity
```
org.djunits.value.vdouble.scalar.Speed getMaximumVelocity()
```
    Returns:
    
    the maximum velocity of the GTU, in the linear direction.
  - getMaximumAcceleration
```
org.djunits.value.vdouble.scalar.Acceleration getMaximumAcceleration()
```
    Returns:
    
    the maximum acceleration of the GTU, in the linear direction.
  - getMaximumDeceleration
```
org.djunits.value.vdouble.scalar.Acceleration getMaximumDeceleration()
```
    Returns:
    
    the maximum deceleration of the GTU, in the linear direction, stored as a negative number.
  - 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.Speed getVelocity(org.djunits.value.vdouble.scalar.Time.Abs time)
                                            throws GTUException
```
    Parameters:
    
    time - the time for which the velocity needs to be calculated.
    
    Returns:
    
    the acceleration of the GTU at the given time, combining longitudinal, lateral and vertical acceleration components.
    
    Throws:
    
    GTUException - when the time is outside the current operational plan's interval
  - getVelocity
```
org.djunits.value.vdouble.scalar.Speed getVelocity()
```
    Returns:
    
    the current velocity of the GTU, combining longitudinal, lateral and vertical speed components.
  - getRelativePositions
```
Map<RelativePosition.TYPE,RelativePosition> getRelativePositions()
```
    Returns:
    
    the positions for this GTU.
  - destroy
```
void destroy()
```
    destroy the GTU from the simulation and animation.
  - getAcceleration
```
org.djunits.value.vdouble.scalar.Acceleration getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs time)
                                                       throws GTUException
```
    Parameters:
    
    time - the time for which the acceleration needs to be calculated.
    
    Returns:
    
    the acceleration of the GTU at the given time, combining longitudinal, lateral and vertical acceleration components.
    
    Throws:
    
    GTUException - when the time is outside the current operational plan's interval
  - getAcceleration
```
org.djunits.value.vdouble.scalar.Acceleration getAcceleration()
```
    Returns:
    
    the current acceleration of the GTU, combining longitudinal, lateral and vertical acceleration components.
  - getOdometer
```
org.djunits.value.vdouble.scalar.Length.Rel getOdometer()
```
    Returns:
    
    Length.Rel; the current odometer value.
  - getStrategicalPlanner
```
StrategicalPlanner getStrategicalPlanner()
```
    Returns:
    
    strategicalPlanner the planner responsible for the overall 'mission' of the GTU, usually indicating where it needs to go. It operates by instantiating tactical planners to do the work.
  - getTacticalPlanner
```
TacticalPlanner getTacticalPlanner()
```
    Returns:
    
    tacticalPlanner the tactical planner that can generate an operational plan
  - getOperationalPlan
```
OperationalPlan getOperationalPlan()
```
    Returns:
    
    the operational plan for the GTU.
  - getPerception
```
Perception getPerception()
```
    Returns:
    
    the perception module of this GTU
  - getDrivingCharacteristics
```
DrivingCharacteristics getDrivingCharacteristics()
```
    Returns:
    
    the driving characteristics of this GTU (driver).
  - getLocation
```
nl.tudelft.simulation.language.d3.DirectedPoint getLocation()
```
    Specified by:
    
    getLocation in interface nl.tudelft.simulation.dsol.animation.LocatableInterface
  - getBounds
```
javax.media.j3d.Bounds getBounds()
```
    Specified by:
    
    getBounds in interface nl.tudelft.simulation.dsol.animation.LocatableInterface

Interface GTU

Method Summary

Method Detail

getId

getLength

getWidth

getMaximumVelocity

getMaximumAcceleration

getMaximumDeceleration

getGTUType

getSimulator

getReference

getFront

getRear

getVelocity

getVelocity

getRelativePositions

destroy

getAcceleration

getAcceleration

getOdometer

getStrategicalPlanner

getTacticalPlanner

getOperationalPlan

getPerception

getDrivingCharacteristics

getLocation

getBounds