org.opentrafficsim.road.gtu.lane

Interface LaneBasedGTU

All Superinterfaces:

org.opentrafficsim.core.gtu.GTU, nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable

All Known Implementing Classes:

AbstractLaneBasedGTU, AbstractLaneBasedIndividualGTU, AbstractTrafficLight, CopyOfAbstractLaneBasedGTU, LaneBasedIndividualGTU, LaneBlock, LaneBlockOnOff, RTICars, SimpleTrafficLight

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

This interface defines a lane based GTU.

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: 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

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	enterLane(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel 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.Abs 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.Abs 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.
LaneBasedBehavioralCharacteristics	getBehavioralCharacteristics()
Map<Lane,org.opentrafficsim.core.gtu.GTUDirectionality>	getLanes()
LanePerceptionFull	getPerception()
LaneBasedStrategicalPlanner	getStrategicalPlanner()
void	leaveLane(Lane lane) Unregister the GTU from a lane.
org.djunits.value.vdouble.scalar.Length.Rel	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.Rel	position(Lane lane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time.Abs 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.Rel>	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.Rel>	positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time.Abs 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.Rel	projectedPosition(Lane projectionLane, org.opentrafficsim.core.gtu.RelativePosition relativePosition, org.djunits.value.vdouble.scalar.Time.Abs when) Return the longitudinal position that 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, getAcceleration, getBounds, getFront, getGTUType, getId, getLength, getLocation, getMaximumAcceleration, getMaximumDeceleration, getMaximumVelocity, getOdometer, getOperationalPlan, getRear, getReference, getRelativePositions, getSimulator, getTacticalPlanner, getTurnIndicatorStatus, getVelocity, getVelocity, getWidth, setTurnIndicatorStatus

Method Detail

getPerception

LanePerceptionFull getPerception()

Specified by:

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

getBehavioralCharacteristics

LaneBasedBehavioralCharacteristics getBehavioralCharacteristics()

Specified by:

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

getStrategicalPlanner

LaneBasedStrategicalPlanner getStrategicalPlanner()

Specified by:

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

getLanes

Map<Lane,org.opentrafficsim.core.gtu.GTUDirectionality> getLanes()

Returns:

a safe copy of the lanes on which the GTU is registered.

enterLane

void enterLane(Lane lane,
               org.djunits.value.vdouble.scalar.Length.Rel 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 velocity, 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

positions

Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> 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.Rel> positions(org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                                org.djunits.value.vdouble.scalar.Time.Abs 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.Rel 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.Rel position(Lane lane,
                                                     org.opentrafficsim.core.gtu.RelativePosition relativePosition,
                                                     org.djunits.value.vdouble.scalar.Time.Abs 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.Abs 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.Abs 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.

projectedPosition

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

Return the longitudinal position that this GTU would have if it were to change to another Lane with a / the current CrossSectionLink.

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.Abs; the time for which to project the position of this GTU

Returns:

Length.Rel; 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

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