org.opentrafficsim.road.gtu.lane

Interface LaneBasedGTU

All Superinterfaces:

nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.core.gtu.GTU, nl.tudelft.simulation.dsol.animation.Locatable, Serializable

All Known Implementing Classes:

AbstractLaneBasedGTU, AbstractLaneBasedIndividualGTU, LaneBasedIndividualGTU

public interface LaneBasedGTU
extends org.opentrafficsim.core.gtu.GTU

This interface defines a lane based GTU.

Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 1401 $, $LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, by $Author: averbraeck $, initial version Oct 22, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields

Modifier and Type	Field and Description
static nl.tudelft.simulation.event.EventType	LANE_ENTER_EVENT The event type for pub/sub indicating that the GTU entered a new lane (with the FRONT position if driving forward; REAR if driving backward).
static nl.tudelft.simulation.event.EventType	LANE_EXIT_EVENT The event type for pub/sub indicating that the GTU exited a lane (with the REAR position if driving forward; FRONT if driving backward).
static nl.tudelft.simulation.event.EventType	LANEBASED_DESTROY_EVENT The lane-based event type for pub/sub indicating destruction of the GTU.
static nl.tudelft.simulation.event.EventType	LANEBASED_INIT_EVENT The lane-based event type for pub/sub indicating the initialization of a new GTU.
static nl.tudelft.simulation.event.EventType	LANEBASED_MOVE_EVENT The lane-based event type for pub/sub indicating a move.
static nl.tudelft.simulation.event.EventType	LINK_ENTER_EVENT The event type for pub/sub indicating that the GTU entered a new link (with the FRONT position if driving forward; REAR if driving backward).
static nl.tudelft.simulation.event.EventType	LINK_EXIT_EVENT The event type for pub/sub indicating that the GTU exited a link (with the REAR position if driving forward; FRONT if driving backward).

Fields inherited from interface org.opentrafficsim.core.gtu.GTU

DESTROY_EVENT, INIT_EVENT, MOVE_EVENT

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

FIRST_POSITION, LAST_POSITION

Method Summary

Modifier and Type	Method and Description
void	addTrigger(Lane lane, nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<org.opentrafficsim.core.dsol.OTSSimTimeDouble> event) Add an event to the list of lane triggers scheduled for this GTU.
void	changeLaneInstantaneously(org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection) Change lanes instantaneously.
void	enterLane(Lane lane, org.djunits.value.vdouble.scalar.Length position, org.opentrafficsim.core.gtu.GTUDirectionality gtuDirection) insert GTU at a certain position.
double	fractionalPosition(Lane lane, org.opentrafficsim.core.gtu.RelativePosition relativePosition) Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane, as a fraction of the length of the lane.
double	fractionalPosition(Lane lane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane, as a fraction of the length of the lane.
Map<Lane,Double>	fractionalPositions(org.opentrafficsim.core.gtu.RelativePosition relativePosition) Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered, as fractions of the length of the lane.
Map<Lane,Double>	fractionalPositions(org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered, as fractions of the length of the lane.
org.opentrafficsim.core.gtu.GTUDirectionality	getDirection(Lane lane) Return the directionality of a lane on which the GTU is registered for its current operational plan.
nl.tudelft.simulation.language.d3.DirectedPoint	getLocation() Return the location without a RemoteException.
DirectedLanePosition	getReferencePosition() Return the current Lane, position and directionality of the GTU.
LaneBasedStrategicalPlanner	getStrategicalPlanner()
LaneBasedTacticalPlanner	getTacticalPlanner()
boolean	laneChangeAllowed() Returns whether a lane change is allowed.
void	leaveLane(Lane lane) Unregister the GTU from a lane.
org.djunits.value.vdouble.scalar.Length	position(Lane lane, org.opentrafficsim.core.gtu.RelativePosition relativePosition) Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane at the current simulation time.
org.djunits.value.vdouble.scalar.Length	position(Lane lane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane.
Map<Lane,org.djunits.value.vdouble.scalar.Length>	positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition) Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered.
Map<Lane,org.djunits.value.vdouble.scalar.Length>	positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered.
org.djunits.value.vdouble.scalar.Length	projectedPosition(Lane projectionLane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal position on the projection lane that has the same fractional position on one of the current lanes of the indicated relative position.
void	setNoLaneChangeDistance(org.djunits.value.vdouble.scalar.Length distance) Set distance over which the GTU should not change lane after being created.
org.djunits.value.vdouble.scalar.Length	translatedPosition(Lane projectionLane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time when) Return the longitudinal position that the indicated relative position of this GTU would have if it were to change to another Lane with a / the current CrossSectionLink.

Methods inherited from interface org.opentrafficsim.core.gtu.GTU

destroy, getAcceleration, getBaseColor, getBehavioralCharacteristics, getCenter, getContourPoints, getFront, getGTUType, getId, getLength, getMaximumAcceleration, getMaximumDeceleration, getMaximumSpeed, getOdometer, getOperationalPlan, getRear, getReference, getRelativePositions, getSimulator, getSpeed, getTurnIndicatorStatus, getWidth, setTurnIndicatorStatus

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

getBounds

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

addListener, addListener, addListener, addListener, removeListener

Field Detail

LANEBASED_INIT_EVENT

static final nl.tudelft.simulation.event.EventType LANEBASED_INIT_EVENT

The lane-based event type for pub/sub indicating the initialization of a new GTU.
Payload: [String gtuId, DirectedPoint initialPosition, Length length, Length width, Color gtuBaseColor, Lane referenceLane, Length positionOnReferenceLane, GTUDirectionality direction, GTUType gtuType]

LANEBASED_MOVE_EVENT

static final nl.tudelft.simulation.event.EventType LANEBASED_MOVE_EVENT

The lane-based event type for pub/sub indicating a move.
Payload: [String gtuId, DirectedPoint position, Speed speed, Acceleration acceleration, TurnIndicatorStatus turnIndicatorStatus, Length odometer, Lane referenceLane, Length positionOnReferenceLane, GTUDirectionality direction]

LANEBASED_DESTROY_EVENT

static final nl.tudelft.simulation.event.EventType LANEBASED_DESTROY_EVENT

The lane-based event type for pub/sub indicating destruction of the GTU.
Payload: [String gtuId, DirectedPoint lastPosition, Length odometer, Lane referenceLane, Length positionOnReferenceLane, GTUDirectionality direction]

LINK_ENTER_EVENT

static final nl.tudelft.simulation.event.EventType LINK_ENTER_EVENT

The event type for pub/sub indicating that the GTU entered a new link (with the FRONT position if driving forward; REAR if driving backward).
Payload: [String gtuId, Link link]

LINK_EXIT_EVENT

static final nl.tudelft.simulation.event.EventType LINK_EXIT_EVENT

The event type for pub/sub indicating that the GTU exited a link (with the REAR position if driving forward; FRONT if driving backward).
Payload: [String gtuId, Link link]

LANE_ENTER_EVENT

static final nl.tudelft.simulation.event.EventType LANE_ENTER_EVENT

The event type for pub/sub indicating that the GTU entered a new lane (with the FRONT position if driving forward; REAR if driving backward).
Payload: [String gtuId, Lane lane]

LANE_EXIT_EVENT

static final nl.tudelft.simulation.event.EventType LANE_EXIT_EVENT

The event type for pub/sub indicating that the GTU exited a lane (with the REAR position if driving forward; FRONT if driving backward).
Payload: [String gtuId, Lane lane]

Method Detail

getStrategicalPlanner

LaneBasedStrategicalPlanner getStrategicalPlanner()

Specified by:

getStrategicalPlanner in interface org.opentrafficsim.core.gtu.GTU

getTacticalPlanner

LaneBasedTacticalPlanner getTacticalPlanner()

Specified by:

getTacticalPlanner in interface org.opentrafficsim.core.gtu.GTU

getLocation

nl.tudelft.simulation.language.d3.DirectedPoint getLocation()

Return the location without a RemoteException.

Specified by:

getLocation in interface nl.tudelft.simulation.dsol.animation.Locatable

enterLane

void enterLane(Lane lane,
               org.djunits.value.vdouble.scalar.Length position,
               org.opentrafficsim.core.gtu.GTUDirectionality gtuDirection)
        throws org.opentrafficsim.core.gtu.GTUException

insert GTU at a certain position. This can happen at setup (first initialization), and after a lane change of the GTU. The relative position that will be registered is the referencePosition (dx, dy, dz) = (0, 0, 0). Front and rear positions are relative towards this position.

Parameters:

lane - the lane to add to the list of lanes on which the GTU is registered.

gtuDirection - the direction of the GTU on the lane (which can be bidirectional). If the GTU has a positive speed, it is moving in this direction.

position - the position on the lane.

Throws:

org.opentrafficsim.core.gtu.GTUException - when positioning the GTU on the lane causes a problem

leaveLane

void leaveLane(Lane lane)
        throws org.opentrafficsim.core.gtu.GTUException

Unregister the GTU from a lane.

Parameters:

lane - the lane to remove from the list of lanes on which the GTU is registered.

Throws:

org.opentrafficsim.core.gtu.GTUException - when leaveLane should not be called

changeLaneInstantaneously

void changeLaneInstantaneously(org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection)
                        throws org.opentrafficsim.core.gtu.GTUException

Change lanes instantaneously.

Parameters:

laneChangeDirection - the direction to change to

Throws:

org.opentrafficsim.core.gtu.GTUException - in case lane change fails

positions

Map<Lane,org.djunits.value.vdouble.scalar.Length> positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition)
                                                     throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered.
Note: If a GTU is registered in multiple parallel lanes, the lateralLaneChangeModel is used to determine the center line of the vehicle at this point in time. Otherwise, the average of the center positions of the lines will be taken.

Parameters:

relativePosition - the position on the vehicle relative to the reference point.

Returns:

the lanes and the position on the lanes where the GTU is currently registered, for the given position of the GTU.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on one of the lanes on which it is registered.

positions

Map<Lane,org.djunits.value.vdouble.scalar.Length> positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                            org.djunits.value.vdouble.scalar.Time when)
                                                     throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered.

Parameters:

relativePosition - the position on the vehicle relative to the reference point.

when - the future time for which to calculate the positions.

Returns:

the lanes and the position on the lanes where the GTU will be registered at the time, for the given position of the GTU.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on one of the lanes on which it is registered.

position

org.djunits.value.vdouble.scalar.Length position(Lane lane,
                                                 org.opentrafficsim.core.gtu.RelativePosition relativePosition)
                                          throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane at the current simulation time.

Parameters:

lane - the position on this lane will be returned.

relativePosition - the position on the vehicle relative to the reference point.

Returns:

DoubleScalarAbs<LengthUnit>; the position, relative to the center line of the Lane.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on the given lane.

position

org.djunits.value.vdouble.scalar.Length position(Lane lane,
                                                 org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                 org.djunits.value.vdouble.scalar.Time when)
                                          throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane.

Parameters:

lane - the position on this lane will be returned.

relativePosition - the position on the vehicle relative to the reference point.

when - the future time for which to calculate the positions.

Returns:

DoubleScalarAbs<LengthUnit>; the position, relative to the center line of the Lane.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on the given lane.

fractionalPositions

Map<Lane,Double> fractionalPositions(org.opentrafficsim.core.gtu.RelativePosition relativePosition)
                              throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered, as fractions of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.

Parameters:

relativePosition - the position on the vehicle relative to the reference point.

Returns:

the lanes and the position on the lanes where the GTU is currently registered, for the given position of the GTU.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on one of the lanes on which it is registered.

fractionalPositions

Map<Lane,Double> fractionalPositions(org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                     org.djunits.value.vdouble.scalar.Time when)
                              throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal positions of a point relative to this GTU, relative to the center line of the Lanes in which the vehicle is registered, as fractions of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.

Parameters:

relativePosition - the position on the vehicle relative to the reference point.

when - the future time for which to calculate the positions.

Returns:

the lanes and the position on the lanes where the GTU will be registered at the time, for the given position of the GTU.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on one of the lanes on which it is registered.

fractionalPosition

double fractionalPosition(Lane lane,
                          org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                          org.djunits.value.vdouble.scalar.Time when)
                   throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane, as a fraction of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.

Parameters:

lane - the position on this lane will be returned.

relativePosition - the position on the vehicle relative to the reference point.

when - the future time for which to calculate the positions.

Returns:

the fractional relative position on the lane at the given time.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on the given lane.

fractionalPosition

double fractionalPosition(Lane lane,
                          org.opentrafficsim.core.gtu.RelativePosition relativePosition)
                   throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position of a point relative to this GTU, relative to the center line of the Lane, as a fraction of the length of the lane. This is important when we want to see if two vehicles are next to each other and we compare an 'inner' and 'outer' curve.

Parameters:

lane - the position on this lane will be returned.

relativePosition - the position on the vehicle relative to the reference point.

Returns:

the fractional relative position on the lane at the given time.

Throws:

org.opentrafficsim.core.gtu.GTUException - when the vehicle is not on the given lane.

translatedPosition

org.djunits.value.vdouble.scalar.Length translatedPosition(Lane projectionLane,
                                                           org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                           org.djunits.value.vdouble.scalar.Time when)
                                                    throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position that the indicated relative position of this GTU would have if it were to change to another Lane with a / the current CrossSectionLink. This point may be before the begin or after the end of the link of the projection lane of the GTU. This preserves the length of the GTU.

Parameters:

projectionLane - Lane; the lane onto which the position of this GTU must be projected

relativePosition - RelativePosition; the point on this GTU that must be projected

when - Time; the time for which to project the position of this GTU

Returns:

Length; the position of this GTU in the projectionLane

Throws:

org.opentrafficsim.core.gtu.GTUException - when projectionLane it not in any of the CrossSectionLink that the GTU is on

projectedPosition

org.djunits.value.vdouble.scalar.Length projectedPosition(Lane projectionLane,
                                                          org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                          org.djunits.value.vdouble.scalar.Time when)
                                                   throws org.opentrafficsim.core.gtu.GTUException

Return the longitudinal position on the projection lane that has the same fractional position on one of the current lanes of the indicated relative position. This preserves the fractional positions of all relative positions of the GTU.

Parameters:

projectionLane - Lane; the lane onto which the position of this GTU must be projected

relativePosition - RelativePosition; the point on this GTU that must be projected

when - Time; the time for which to project the position of this GTU

Returns:

Length; the position of this GTU in the projectionLane

Throws:

org.opentrafficsim.core.gtu.GTUException - when projectionLane it not in any of the CrossSectionLink that the GTU is on

getReferencePosition

DirectedLanePosition getReferencePosition()
                                   throws org.opentrafficsim.core.gtu.GTUException

Return the current Lane, position and directionality of the GTU.

Returns:

DirectedLanePosition; the current Lane, position and directionality of the GTU

Throws:

org.opentrafficsim.core.gtu.GTUException - in case the reference position of the GTU cannot be found on the lanes in its current path

getDirection

org.opentrafficsim.core.gtu.GTUDirectionality getDirection(Lane lane)
                                                    throws org.opentrafficsim.core.gtu.GTUException

Return the directionality of a lane on which the GTU is registered for its current operational plan.

Parameters:

lane - Lane; the lane for which we want to know the direction

Returns:

GTUDirectionality; the direction on the given lane

Throws:

org.opentrafficsim.core.gtu.GTUException - in case the GTU is not registered on the Lane

addTrigger

void addTrigger(Lane lane,
                nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<org.opentrafficsim.core.dsol.OTSSimTimeDouble> event)

Add an event to the list of lane triggers scheduled for this GTU.

Parameters:

lane - Lane; the lane on which the event occurs

event - SimeEvent<OTSSimTimeDouble> the event

setNoLaneChangeDistance

void setNoLaneChangeDistance(org.djunits.value.vdouble.scalar.Length distance)

Set distance over which the GTU should not change lane after being created.

Parameters:

distance - distance over which the GTU should not change lane after being created

laneChangeAllowed

boolean laneChangeAllowed()

Returns whether a lane change is allowed.

Returns:

whether a lane change is allowed