GTU (Open Traffic Sim core classes 0.12.00 API)

All Superinterfaces:

nl.tudelft.simulation.event.EventProducerInterface, nl.tudelft.simulation.dsol.animation.Locatable, Serializable

All Known Subinterfaces:

SpaceBasedGTU

All Known Implementing Classes:

AbstractGTU, AbstractLinkBasedGTU
```
public interface GTU
extends nl.tudelft.simulation.dsol.animation.Locatable, Serializable, nl.tudelft.simulation.event.EventProducerInterface
```
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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 2398 $, $LastChangedDate: 2016-10-18 14:07:25 +0200 (Tue, 18 Oct 2016) $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields
Modifier and Type	Field and Description
`static nl.tudelft.simulation.event.EventType`	`DESTROY_EVENT` The event type for pub/sub indicating destruction of the GTU.
`static nl.tudelft.simulation.event.EventType`	`INIT_EVENT` The event type for pub/sub indicating the initialization of a new GTU.
`static nl.tudelft.simulation.event.EventType`	`MOVE_EVENT` The event type for pub/sub indicating a move.

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface
FIRST_POSITION, LAST_POSITION

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()`
`Color`	`getBaseColor()` Return the base color of the GTU (not the state-based color).
`BehavioralCharacteristics`	`getBehavioralCharacteristics()`
`RelativePosition`	`getCenter()`
`org.opentrafficsim.base.immutablecollections.ImmutableSet<RelativePosition>`	`getContourPoints()`
`RelativePosition`	`getFront()`
`GTUType`	`getGTUType()`
`String`	`getId()`
`org.djunits.value.vdouble.scalar.Length`	`getLength()`
`org.djunits.value.vdouble.scalar.Acceleration`	`getMaximumAcceleration()`
`org.djunits.value.vdouble.scalar.Acceleration`	`getMaximumDeceleration()`
`org.djunits.value.vdouble.scalar.Speed`	`getMaximumSpeed()`
`org.djunits.value.vdouble.scalar.Length`	`getOdometer()`
`OperationalPlan`	`getOperationalPlan()`
`RelativePosition`	`getRear()`
`RelativePosition`	`getReference()`
`org.opentrafficsim.base.immutablecollections.ImmutableMap<RelativePosition.TYPE,RelativePosition>`	`getRelativePositions()`
`OTSDEVSSimulatorInterface`	`getSimulator()`
`org.djunits.value.vdouble.scalar.Speed`	`getSpeed()`
`StrategicalPlanner`	`getStrategicalPlanner()`
`TacticalPlanner`	`getTacticalPlanner()`
`TurnIndicatorStatus`	`getTurnIndicatorStatus()`
`org.djunits.value.vdouble.scalar.Length`	`getWidth()`
`void`	`setTurnIndicatorStatus(TurnIndicatorStatus turnIndicatorStatus)` Set the status of the turn indicator.

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable
getBounds, getLocation

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface
addListener, addListener, addListener, addListener, removeListener

- Field Detail
  - INIT_EVENT
```
static final nl.tudelft.simulation.event.EventType INIT_EVENT
```
    The event type for pub/sub indicating the initialization of a new GTU.
    Payload: [String id, DirectedPoint initialPosition, Length length, Length width, Color gtuBaseColor]
  - MOVE_EVENT
```
static final nl.tudelft.simulation.event.EventType MOVE_EVENT
```
    The event type for pub/sub indicating a move.
    Payload: [String id, DirectedPoint position, Speed speed, Acceleration acceleration, TurnIndicatorStatus turnIndicatorStatus, Length odometer]
  - DESTROY_EVENT
```
static final nl.tudelft.simulation.event.EventType DESTROY_EVENT
```
    The event type for pub/sub indicating destruction of the GTU.
    Payload: [String id, DirectedPoint lastPosition, Length odometer]
- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    the id of the GTU
  - getLength
```
org.djunits.value.vdouble.scalar.Length getLength()
```
    Returns:
    
    the maximum length of the GTU (parallel with driving direction).
  - getWidth
```
org.djunits.value.vdouble.scalar.Length getWidth()
```
    Returns:
    
    the maximum width of the GTU (perpendicular to driving direction).
  - getMaximumSpeed
```
org.djunits.value.vdouble.scalar.Speed getMaximumSpeed()
```
    Returns:
    
    the maximum speed of the GTU, in the direction of movement.
  - 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.
  - getCenter
```
RelativePosition getCenter()
```
    Returns:
    
    the center position of the GTU, relative to its reference point.
  - getContourPoints
```
org.opentrafficsim.base.immutablecollections.ImmutableSet<RelativePosition> getContourPoints()
```
    Returns:
    
    the contour points of the GTU.
  - getRelativePositions
```
org.opentrafficsim.base.immutablecollections.ImmutableMap<RelativePosition.TYPE,RelativePosition> getRelativePositions()
```
    Returns:
    
    the positions for this GTU, but not the contour points.
  - getSpeed
```
org.djunits.value.vdouble.scalar.Speed getSpeed()
```
    Returns:
    
    the current speed of the GTU, along the direction of movement.
  - getAcceleration
```
org.djunits.value.vdouble.scalar.Acceleration getAcceleration()
```
    Returns:
    
    the current acceleration of the GTU, along the direction of movement.
  - getOdometer
```
org.djunits.value.vdouble.scalar.Length getOdometer()
```
    Returns:
    
    Length; the current odometer value.
  - getBehavioralCharacteristics
```
BehavioralCharacteristics getBehavioralCharacteristics()
```
    Returns:
    
    Behavioral characteristics.
  - 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 current tactical planner that can generate an operational plan
  - getOperationalPlan
```
OperationalPlan getOperationalPlan()
```
    Returns:
    
    the current operational plan for the GTU.
  - getTurnIndicatorStatus
```
TurnIndicatorStatus getTurnIndicatorStatus()
```
    Returns:
    
    the status of the turn indicator.
  - setTurnIndicatorStatus
```
void setTurnIndicatorStatus(TurnIndicatorStatus turnIndicatorStatus)
                     throws GTUException
```
    Set the status of the turn indicator.
    
    Parameters:
    
    turnIndicatorStatus - the new status of the turn indicator.
    
    Throws:
    
    GTUException - when GTUType does not have a turn indicator
  - destroy
```
void destroy()
```
    Destroy the GTU from the simulation and animation.
  - getBaseColor
```
Color getBaseColor()
```
    Return the base color of the GTU (not the state-based color).
    
    Returns:
    
    Color; the base color of the GTU (not the state-based color)

Interface GTU

Field Summary

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

Method Summary

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

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

Field Detail

INIT_EVENT

MOVE_EVENT

DESTROY_EVENT

Method Detail

getId

getLength

getWidth

getMaximumSpeed

getMaximumAcceleration

getMaximumDeceleration

getGTUType

getSimulator

getReference

getFront

getRear

getCenter

getContourPoints

getRelativePositions

getSpeed

getAcceleration

getOdometer

getBehavioralCharacteristics

getStrategicalPlanner

getTacticalPlanner

getOperationalPlan

getTurnIndicatorStatus

setTurnIndicatorStatus

destroy

getBaseColor