GTU (Open Traffic Sim core classes 1.00.01 API)

All Superinterfaces:

nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifiable, 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, org.opentrafficsim.base.Identifiable
```
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-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 4006 $, $LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, 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 Default Methods
Modifier and Type	Method and Description
`void`	`addGtu(GTU gtu)` Adds the provided GTU to this GTU, meaning it moves with this GTU.
`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 time)`
`Color`	`getBaseColor()` Return the base color of the GTU (not the state-based color).
`RelativePosition`	`getCenter()`
`Set<GTU>`	`getChildren()` Returns the children GTU's.
`nl.tudelft.simulation.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()`
`org.djunits.value.vdouble.scalar.Length`	`getOdometer(org.djunits.value.vdouble.scalar.Time time)`
`OperationalPlan`	`getOperationalPlan()`
`OperationalPlan`	`getOperationalPlan(org.djunits.value.vdouble.scalar.Time time)`
`org.opentrafficsim.base.parameters.Parameters`	`getParameters()`
`GTU`	`getParent()` Returns the parent GTU, or `null` if this GTU has no parent.
`RelativePosition`	`getRear()`
`RelativePosition`	`getReference()`
`nl.tudelft.simulation.immutablecollections.ImmutableMap<RelativePosition.TYPE,RelativePosition>`	`getRelativePositions()`
`nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit`	`getSimulator()`
`org.djunits.value.vdouble.scalar.Speed`	`getSpeed()`
`org.djunits.value.vdouble.scalar.Speed`	`getSpeed(org.djunits.value.vdouble.scalar.Time time)`
`StrategicalPlanner`	`getStrategicalPlanner()`
`StrategicalPlanner`	`getStrategicalPlanner(org.djunits.value.vdouble.scalar.Time time)`
`default TacticalPlanner<?,?>`	`getTacticalPlanner()`
`default TacticalPlanner<?,?>`	`getTacticalPlanner(org.djunits.value.vdouble.scalar.Time time)`
`org.djunits.value.vdouble.scalar.Length`	`getWidth()`
`boolean`	`isDestroyed()` Returns whether the GTU is destroyed.
`void`	`removeGtu(GTU gtu)` Removes the provided GTU from this GTU, meaning it no longer moves with this GTU.
`void`	`setParameters(org.opentrafficsim.base.parameters.Parameters parameters)`
`void`	`setParent(GTU gtu)` Set the parent GTU.

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, 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()
```
    Specified by:
    
    getId in interface org.opentrafficsim.base.Identifiable
    
    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
```
nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit 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
```
nl.tudelft.simulation.immutablecollections.ImmutableSet<RelativePosition> getContourPoints()
```
    Returns:
    
    the contour points of the GTU.
  - getRelativePositions
```
nl.tudelft.simulation.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.
  - getSpeed
```
org.djunits.value.vdouble.scalar.Speed getSpeed(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time at which to obtain the speed
    
    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.
  - getAcceleration
```
org.djunits.value.vdouble.scalar.Acceleration getAcceleration(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time at which to obtain the acceleration
    
    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.
  - getOdometer
```
org.djunits.value.vdouble.scalar.Length getOdometer(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time to obtain the odometer at
    
    Returns:
    
    Length; the odometer value at given time.
  - getParameters
```
org.opentrafficsim.base.parameters.Parameters getParameters()
```
    Returns:
    
    Parameters.
  - setParameters
```
void setParameters(org.opentrafficsim.base.parameters.Parameters parameters)
```
    Parameters:
    
    parameters - Parameters; parameters
  - 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.
  - getStrategicalPlanner
```
StrategicalPlanner getStrategicalPlanner(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time to obtain the strategical planner at
    
    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
```
default TacticalPlanner<?,?> getTacticalPlanner()
```
    Returns:
    
    TacticalPlanner; the current tactical planner that can generate an operational plan
  - getTacticalPlanner
```
default TacticalPlanner<?,?> getTacticalPlanner(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time to obtain the tactical planner at
    
    Returns:
    
    TacticalPlanner; the tactical planner that can generate an operational plan at the given time
  - getOperationalPlan
```
OperationalPlan getOperationalPlan()
```
    Returns:
    
    the current operational plan for the GTU
  - getOperationalPlan
```
OperationalPlan getOperationalPlan(org.djunits.value.vdouble.scalar.Time time)
```
    Parameters:
    
    time - Time; time to obtain the operational plan at
    
    Returns:
    
    the operational plan for the GTU at the given time.
  - destroy
```
void destroy()
```
    Destroy the GTU from the simulation and animation.
  - isDestroyed
```
boolean isDestroyed()
```
    Returns whether the GTU is destroyed.
    
    Returns:
    
    whether the GTU is destroyed
  - 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)
  - addGtu
```
void addGtu(GTU gtu)
     throws GTUException
```
    Adds the provided GTU to this GTU, meaning it moves with this GTU.
    
    Parameters:
    
    gtu - GTU; gtu to enter this GTU
    
    Throws:
    
    GTUException - if the gtu already has a parent
  - removeGtu
```
void removeGtu(GTU gtu)
```
    Removes the provided GTU from this GTU, meaning it no longer moves with this GTU.
    
    Parameters:
    
    gtu - GTU; gtu to exit this GTU
  - setParent
```
void setParent(GTU gtu)
        throws GTUException
```
    Set the parent GTU.
    
    Parameters:
    
    gtu - GTU; parent GTU, may be null
    
    Throws:
    
    GTUException - if the gtu already has a parent
  - getParent
```
GTU getParent()
```
    Returns the parent GTU, or null if this GTU has no parent.
    
    Returns:
    
    GTU; parent GTU, or null if this GTU has no parent
  - getChildren
```
Set<GTU> getChildren()
```
    Returns the children GTU's.
    
    Returns:
    
    Set<GTU>; children GTU's

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

getSpeed

getAcceleration

getAcceleration

getOdometer

getOdometer

getParameters

setParameters

getStrategicalPlanner

getStrategicalPlanner

getTacticalPlanner

getTacticalPlanner

getOperationalPlan

getOperationalPlan

destroy

isDestroyed

getBaseColor

addGtu

removeGtu

setParent

getParent

getChildren