org.opentrafficsim.road.network.lane

Class Lane

java.lang.Object

org.opentrafficsim.road.network.lane.CrossSectionElement

org.opentrafficsim.road.network.lane.Lane

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface, org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, org.opentrafficsim.core.OTS_SCALAR

Direct Known Subclasses:

NoTrafficLane

public class Lane
extends CrossSectionElement
implements Serializable, org.opentrafficsim.core.OTS_SCALAR

The Lane is the CrossSectionElement of a CrossSectionLink on which GTUs can drive. The Lane stores several important properties, such as the successor lane(s), predecessor lane(s), and adjacent lane(s), all separated per GTU type. It can, for instance, be that a truck is not allowed to move into an adjacent lane, while a car is allowed to do so. Furthermore, the lane contains sensors that can be triggered by passing GTUs. The Lane class also contains methods to determine to trigger the sensors at exactly calculated and scheduled times, given the movement of the GTUs.
Finally, the Lane stores the GTUs on the lane, and contains several access methods to determine successor and predecessor GTUs, as well as methods to add a GTU to a lane (either at the start or in the middle when changing lanes), and remove a GTU from the lane (either at the end, or in the middle when changing onto another lane).

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.

$LastChangedDate: 2015-09-24 14:17:07 +0200 (Thu, 24 Sep 2015) $, @version $Revision: 1407 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR

org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Acceleration, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AnglePlane, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSlope, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSolid, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Area, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Density, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Dimensionless, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCharge, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCurrent, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalPotential, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalResistance, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Energy, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowMass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowVolume, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Force, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Frequency, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Length, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.LinearDensity, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Mass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Power, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Pressure, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Speed, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Temperature, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Time, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Torque, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Volume

Field Summary

Fields inherited from class org.opentrafficsim.road.network.lane.CrossSectionElement

beginWidth, designLineOffsetAtBegin, designLineOffsetAtEnd, endWidth, length, parentLink

Fields inherited from interface org.djunits.unit.UNITS

ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEG, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RAD, RADIAN, RPM, SECOND, SLOPE_ARCMINUTE, SLOPE_ARCSECOND, SLOPE_CENTESIMAL_ARCMINUTE, SLOPE_CENTESIMAL_ARCSECOND, SLOPE_DEGREE, SLOPE_GRAD, SLOPE_RADIAN, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

Constructor Summary

Constructors

Constructor and Description
Lane(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtStart, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd, org.djunits.value.vdouble.scalar.Length.Rel beginWidth, org.djunits.value.vdouble.scalar.Length.Rel endWidth, LaneType laneType, org.opentrafficsim.core.network.LongitudinalDirectionality directionality, org.djunits.value.vdouble.scalar.Speed.Abs speedLimit, OvertakingConditions overtakingConditions)
Lane(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtStart, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd, org.djunits.value.vdouble.scalar.Length.Rel beginWidth, org.djunits.value.vdouble.scalar.Length.Rel endWidth, LaneType laneType, Map<org.opentrafficsim.core.gtu.GTUType,org.opentrafficsim.core.network.LongitudinalDirectionality> directionalityMap, Map<org.opentrafficsim.core.gtu.GTUType,org.djunits.value.vdouble.scalar.Speed.Abs> speedLimitMap, OvertakingConditions overtakingConditions)

Method Summary

Modifier and Type	Method and Description
Set<Lane>	accessibleAdjacentLanes(org.opentrafficsim.core.network.LateralDirectionality lateralDirection, org.opentrafficsim.core.gtu.GTUType gtuType) Determine the set of lanes to the left or to the right of this lane, which are accessible from this lane, or an empty set if no lane could be found.
int	addGTU(LaneBasedGTU gtu, double fractionalPosition) Add a LaneBasedGTU to the list of this Lane.
int	addGTU(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition) Add a LaneBasedGTU to the list of this Lane.
void	addSampler(LaneBasedGTUSampler sampler) Register a LaneBasedGTUSampler on this Lane.
void	addSensor(Sensor sensor, org.opentrafficsim.core.gtu.GTUType gtuType) Insert the sensor at the right place in the sensor list of this lane.
boolean	equals(Object obj)
double	fraction(org.djunits.value.vdouble.scalar.Length.Rel position) Transform a position on the lane (can be less than zero or larger than the lane length) to a fraction.
double	fractionSI(double positionSI) Transform a position on the lane in SI units (can be less than zero or larger than the lane length) to a fraction.
org.opentrafficsim.core.network.LongitudinalDirectionality	getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType)
LaneBasedGTU	getGtuAfter(org.djunits.value.vdouble.scalar.Length.Rel position, org.opentrafficsim.core.gtu.RelativePosition.TYPE relativePosition, org.djunits.value.vdouble.scalar.Time.Abs when)
LaneBasedGTU	getGtuBefore(org.djunits.value.vdouble.scalar.Length.Rel position, org.opentrafficsim.core.gtu.RelativePosition.TYPE relativePosition, org.djunits.value.vdouble.scalar.Time.Abs when)
List<LaneBasedGTU>	getGtuList()
LaneType	getLaneType()
OvertakingConditions	getOvertakingConditions()
SortedMap<Double,List<Sensor>>	getSensorMap(org.opentrafficsim.core.gtu.GTUType gtuType) Retrieve the list of Sensors of this Lane for the given GTUType.
List<Sensor>	getSensors() Retrieve the list of all Sensors of this Lane.
List<Sensor>	getSensors(org.opentrafficsim.core.gtu.GTUType gtuType) Retrieve the list of Sensors of this Lane that are triggered by the given GTUType.
List<Sensor>	getSensors(org.djunits.value.vdouble.scalar.Length.Rel minimumPosition, org.djunits.value.vdouble.scalar.Length.Rel maximumPosition, org.opentrafficsim.core.gtu.GTUType gtuType) Retrieve the list of Sensors of this Lane in the specified distance range for the given GTUType.
org.djunits.value.vdouble.scalar.Speed.Abs	getSpeedLimit(org.opentrafficsim.core.gtu.GTUType gtuType)
protected double	getZ()
int	hashCode()
Set<Lane>	nextLanes(org.opentrafficsim.core.gtu.GTUType gtuType) The next lane(s) are cached, as it is too expensive to make the calculation every time.
org.djunits.value.vdouble.scalar.Length.Rel	position(double fraction) Transform a fraction on the lane to a relative length (can be less than zero or larger than the lane length).
double	positionSI(double fraction) Transform a fraction on the lane to a relative length in SI units (can be less than zero or larger than the lane length).
Set<Lane>	prevLanes(org.opentrafficsim.core.gtu.GTUType gtuType) The previous lane(s) are cached, as it is too expensive to make the calculation every time.
void	removeGTU(LaneBasedGTU gtu) Remove a GTU from the GTU list of this lane.
void	removeSampler(LaneBasedGTUSampler sampler) Unregister a LaneBasedGTUSampler from this Lane.
void	removeSensor(Sensor sensor) Remove a sensor from the sensor list of this lane.
void	sample(AbstractLaneBasedGTU gtu) Add the movement of a GTU to all graphs that sample this Lane.
void	scheduleTriggers(LaneBasedGTU gtu, double referenceStartSI, double referenceMoveSI) Trigger the sensors for a certain time step; from now until the nextEvaluationTime of the GTU.
void	setSpeedLimit(org.opentrafficsim.core.gtu.GTUType gtuType, org.djunits.value.vdouble.scalar.Speed.Abs speedLimit)
String	toString()

Methods inherited from class org.opentrafficsim.road.network.lane.CrossSectionElement

constructContour, getBeginWidth, getBounds, getCenterLine, getContour, getDesignLineOffsetAtBegin, getDesignLineOffsetAtEnd, getEndWidth, getId, getLateralBoundaryPosition, getLateralBoundaryPosition, getLateralCenterPosition, getLateralCenterPosition, getLength, getLocation, getParentLink, getWidth, getWidth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Lane

public Lane(CrossSectionLink parentLink,
            String id,
            org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtStart,
            org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd,
            org.djunits.value.vdouble.scalar.Length.Rel beginWidth,
            org.djunits.value.vdouble.scalar.Length.Rel endWidth,
            LaneType laneType,
            Map<org.opentrafficsim.core.gtu.GTUType,org.opentrafficsim.core.network.LongitudinalDirectionality> directionalityMap,
            Map<org.opentrafficsim.core.gtu.GTUType,org.djunits.value.vdouble.scalar.Speed.Abs> speedLimitMap,
            OvertakingConditions overtakingConditions)
     throws org.opentrafficsim.core.geometry.OTSGeometryException,
            org.opentrafficsim.core.network.NetworkException

Parameters:

parentLink - Cross Section Link to which the element belongs.

id - the id of this lane within the link; should be unique within the link.

lateralOffsetAtStart - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the start of the parent Link

lateralOffsetAtEnd - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the end of the parent Link

beginWidth - DoubleScalar.Rel<LengthUnit>; start width, positioned symmetrically around the design line

endWidth - DoubleScalar.Rel<LengthUnit>; end width, positioned symmetrically around the design line

laneType - type of lane to deduce compatibility with GTU types

directionalityMap - in direction of geometry, reverse, or both, specified per GTU Type

speedLimitMap - speed limit on this lane, specified per GTU Type

overtakingConditions - the conditions for overtaking another GTU, viewed from this lane

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the center line or contour geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

Lane

public Lane(CrossSectionLink parentLink,
            String id,
            org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtStart,
            org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd,
            org.djunits.value.vdouble.scalar.Length.Rel beginWidth,
            org.djunits.value.vdouble.scalar.Length.Rel endWidth,
            LaneType laneType,
            org.opentrafficsim.core.network.LongitudinalDirectionality directionality,
            org.djunits.value.vdouble.scalar.Speed.Abs speedLimit,
            OvertakingConditions overtakingConditions)
     throws org.opentrafficsim.core.geometry.OTSGeometryException,
            org.opentrafficsim.core.network.NetworkException

Parameters:

parentLink - Cross Section Link to which the element belongs.

id - the id of this lane within the link; should be unique within the link.

lateralOffsetAtStart - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the start of the parent Link

lateralOffsetAtEnd - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the end of the parent Link

beginWidth - DoubleScalar.Rel<LengthUnit>; start width, positioned symmetrically around the design line

endWidth - DoubleScalar.Rel<LengthUnit>; end width, positioned symmetrically around the design line

laneType - type of lane to deduce compatibility with GTU types

directionality - in direction of geometry, reverse, or both

speedLimit - speed limit on this lane

overtakingConditions - the conditions for overtaking another GTU, viewed from this lane

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the center line or contour geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

Method Detail

addSensor

public final void addSensor(Sensor sensor,
                            org.opentrafficsim.core.gtu.GTUType gtuType)
                     throws org.opentrafficsim.core.network.NetworkException

Insert the sensor at the right place in the sensor list of this lane.

Parameters:

sensor - the sensor to add

gtuType - the GTU type that triggers this sensor; use GTUType.ALL is all GTUs trigger it

Throws:

org.opentrafficsim.core.network.NetworkException - when the position of the sensor is beyond (or before) the range of this Lane

removeSensor

public final void removeSensor(Sensor sensor)
                        throws org.opentrafficsim.core.network.NetworkException

Remove a sensor from the sensor list of this lane.

Parameters:

sensor - the sensor to remove.

Throws:

org.opentrafficsim.core.network.NetworkException - when the sensor was not found on this Lane

getSensors

public final List<Sensor> getSensors(org.djunits.value.vdouble.scalar.Length.Rel minimumPosition,
                                     org.djunits.value.vdouble.scalar.Length.Rel maximumPosition,
                                     org.opentrafficsim.core.gtu.GTUType gtuType)

Retrieve the list of Sensors of this Lane in the specified distance range for the given GTUType. The sensors that are triggered by GTUTypes.ALL are added as well. The resulting list is a defensive copy.

Parameters:

minimumPosition - DoubleScalar.Rel<LengthUnit>; the minimum distance on the Lane (exclusive)

maximumPosition - DoubleScalar.Rel<LengthUnit>; the maximum distance on the Lane (inclusive)

gtuType - the GTU type to provide the sensors for

Returns:

List<Sensor>; list of the sensor in the specified range

getSensors

public final List<Sensor> getSensors(org.opentrafficsim.core.gtu.GTUType gtuType)

Retrieve the list of Sensors of this Lane that are triggered by the given GTUType. The sensors that are triggered by GTUTypes.ALL are added as well. The resulting list is a defensive copy.

Parameters:

gtuType - the GTU type to provide the sensors for

Returns:

List<Sensor>; list of the sensors, in ascending order for the location on the Lane

getSensors

public final List<Sensor> getSensors()

Retrieve the list of all Sensors of this Lane. The resulting list is a defensive copy.

Returns:

List<Sensor>; list of the sensors, in ascending order for the location on the Lane

getSensorMap

public final SortedMap<Double,List<Sensor>> getSensorMap(org.opentrafficsim.core.gtu.GTUType gtuType)

Retrieve the list of Sensors of this Lane for the given GTUType. The sensors that are triggered by GTUTypes.ALL are added as well. The resulting Map is a defensive copy.

Parameters:

gtuType - the GTU type to provide the sensors for

Returns:

all sensors on this lane for the given GTUType as a map per distance

scheduleTriggers

public final void scheduleTriggers(LaneBasedGTU gtu,
                                   double referenceStartSI,
                                   double referenceMoveSI)
                            throws org.opentrafficsim.core.network.NetworkException,
                                   nl.tudelft.simulation.dsol.SimRuntimeException

Trigger the sensors for a certain time step; from now until the nextEvaluationTime of the GTU.

Parameters:

gtu - the LaneBasedGTU for which to trigger the sensors.

referenceStartSI - the SI distance of the GTU reference point on the lane at the current time

referenceMoveSI - the SI distance traveled in the next time step.

Throws:

org.opentrafficsim.core.network.NetworkException - when GTU not on this lane.

nl.tudelft.simulation.dsol.SimRuntimeException - when method cannot be scheduled.

position

public final org.djunits.value.vdouble.scalar.Length.Rel position(double fraction)

Transform a fraction on the lane to a relative length (can be less than zero or larger than the lane length).

Parameters:

fraction - fraction relative to the lane length.

Returns:

relative length corresponding to the fraction.

positionSI

public final double positionSI(double fraction)

Transform a fraction on the lane to a relative length in SI units (can be less than zero or larger than the lane length).

Parameters:

fraction - fraction relative to the lane length.

Returns:

relative length corresponding to the fraction, in SI units.

fraction

public final double fraction(org.djunits.value.vdouble.scalar.Length.Rel position)

Transform a position on the lane (can be less than zero or larger than the lane length) to a fraction.

Parameters:

position - relative length on the lane (may be less than zero or larger than the lane length).

Returns:

fraction fraction relative to the lane length.

fractionSI

public final double fractionSI(double positionSI)

Transform a position on the lane in SI units (can be less than zero or larger than the lane length) to a fraction.

Parameters:

positionSI - relative length on the lane in SI units (may be less than zero or larger than the lane length).

Returns:

fraction fraction relative to the lane length.

addGTU

public final int addGTU(LaneBasedGTU gtu,
                        double fractionalPosition)
                 throws org.opentrafficsim.core.network.NetworkException

Add a LaneBasedGTU to the list of this Lane.

Parameters:

gtu - LaneBasedGTU; the GTU to add

fractionalPosition - double; the fractional position that the newly added GTU will have on this Lane

Returns:

int; the rank that the newly added GTU has on this Lane (should be 0, except when the GTU enters this Lane due to a lane change operation)

Throws:

org.opentrafficsim.core.network.NetworkException - when the fractionalPosition is outside the range 0..1, or the GTU is already registered on this Lane

addGTU

public final int addGTU(LaneBasedGTU gtu,
                        org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition)
                 throws org.opentrafficsim.core.network.NetworkException

Add a LaneBasedGTU to the list of this Lane.

Parameters:

gtu - LaneBasedGTU; the GTU to add

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the longitudinal position that the newly added GTU will have on this Lane

Returns:

int; the rank that the newly added GTU has on this Lane (should be 0, except when the GTU enters this Lane due to a lane change operation)

Throws:

org.opentrafficsim.core.network.NetworkException - when longitudinalPosition is negative or exceeds the length of this Lane

removeGTU

public final void removeGTU(LaneBasedGTU gtu)

Remove a GTU from the GTU list of this lane.

Parameters:

gtu - the GTU to remove.

getGtuAfter

public final LaneBasedGTU getGtuAfter(org.djunits.value.vdouble.scalar.Length.Rel position,
                                      org.opentrafficsim.core.gtu.RelativePosition.TYPE relativePosition,
                                      org.djunits.value.vdouble.scalar.Time.Abs when)
                               throws org.opentrafficsim.core.network.NetworkException

Parameters:

position - the front position after which the relative position of a GTU will be searched.

relativePosition - the relative position of the GTU we are looking for.

when - the time for which to evaluate the positions.

Returns:

the first GTU after a position on this lane, or null if no GTU could be found.

Throws:

org.opentrafficsim.core.network.NetworkException - when there is a problem with the position of the GTUs on the lane.

getGtuBefore

public final LaneBasedGTU getGtuBefore(org.djunits.value.vdouble.scalar.Length.Rel position,
                                       org.opentrafficsim.core.gtu.RelativePosition.TYPE relativePosition,
                                       org.djunits.value.vdouble.scalar.Time.Abs when)
                                throws org.opentrafficsim.core.network.NetworkException

Parameters:

position - the front position before which the relative position of a GTU will be searched.

relativePosition - the relative position of the GTU we are looking for.

when - the time for which to evaluate the positions.

Returns:

the first GTU before a position on this lane, or null if no GTU could be found.

Throws:

org.opentrafficsim.core.network.NetworkException - when there is a problem with the position of the GTUs on the lane.

nextLanes

public final Set<Lane> nextLanes(org.opentrafficsim.core.gtu.GTUType gtuType)

The next lane(s) are cached, as it is too expensive to make the calculation every time. There are several possibilities: returning an empty set when the lane stops and there is no longitudinal transfer method to a next lane. Returning a set with just one lane if the lateral position of the next lane matches the lateral position of this lane (based on an overlap of the lateral positions of the two joining lanes of more than a certain percentage). Multiple lanes in case the Node where the underlying Link for this Lane has multiple outgoing Links, and there are multiple lanes that match the lateral position of this lane.
The next lanes can differ per GTU type. For instance, a lane where cars and buses are allowed can have a next lane where only buses are allowed, forcing the cars to leave that lane.

Parameters:

gtuType - the GTU type for which we return the next lanes.

Returns:

set of Lanes following this lane for the given GTU type.

prevLanes

public final Set<Lane> prevLanes(org.opentrafficsim.core.gtu.GTUType gtuType)

The previous lane(s) are cached, as it is too expensive to make the calculation every time. There are several possibilities: returning an empty set when the lane starts and there is no longitudinal transfer method from a previous lane. Returning a set with just one lane if the lateral position of the previous lane matches the lateral position of this lane (based on an overlap of the lateral positions of the two joining lanes of more than a certain percentage). Multiple lanes in case the Node where the underlying Link for this Lane has multiple incoming Links, and there are multiple lanes that match the lateral position of this lane.
The previous lanes can differ per GTU type. For instance, a lane where cars and buses are allowed can be preceded by a lane where only buses are allowed.

Parameters:

gtuType - the GTU type for which we return the next lanes.

Returns:

set of Lanes following this lane for the given GTU type.

accessibleAdjacentLanes

public final Set<Lane> accessibleAdjacentLanes(org.opentrafficsim.core.network.LateralDirectionality lateralDirection,
                                               org.opentrafficsim.core.gtu.GTUType gtuType)

Determine the set of lanes to the left or to the right of this lane, which are accessible from this lane, or an empty set if no lane could be found. The method takes the LongitidinalDirectionality of the lane into account. In other words, if we drive FORWARD and look for a lane on the LEFT, and there is a lane but the Directionality of that lane is not FORWARD or BOTH, it will not be included.
A lane is called adjacent to another lane if the lateral edges are not more than a delta distance apart. This means that a lane that overlaps with another lane is not returned as an adjacent lane.
Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction.

Parameters:

lateralDirection - LEFT or RIGHT.

gtuType - the type of GTU for which to return the adjacent lanes.

Returns:

the set of lanes that are accessible, or null if there is no lane that is accessible with a matching driving direction.

addSampler

public final void addSampler(LaneBasedGTUSampler sampler)

Register a LaneBasedGTUSampler on this Lane.

Parameters:

sampler - LaneBasedGTUSampler; the sampler to register

removeSampler

public final void removeSampler(LaneBasedGTUSampler sampler)

Unregister a LaneBasedGTUSampler from this Lane.

Parameters:

sampler - LaneBasedGTUSampler; the sampler to unregister

sample

public final void sample(AbstractLaneBasedGTU gtu)
                  throws org.opentrafficsim.core.network.NetworkException

Add the movement of a GTU to all graphs that sample this Lane.

Parameters:

gtu - AbstractLaneBasedGTU; the GTU to sample

Throws:

org.opentrafficsim.core.network.NetworkException - on network inconsistency

getSpeedLimit

public final org.djunits.value.vdouble.scalar.Speed.Abs getSpeedLimit(org.opentrafficsim.core.gtu.GTUType gtuType)

Parameters:

gtuType - the GTU type to provide the speed limit for

Returns:

speedLimit.

setSpeedLimit

public final void setSpeedLimit(org.opentrafficsim.core.gtu.GTUType gtuType,
                                org.djunits.value.vdouble.scalar.Speed.Abs speedLimit)

Parameters:

gtuType - the GTU type to provide the speed limit for

speedLimit - the speed limit for this gtu type

getLaneType

public final LaneType getLaneType()

Returns:

laneType.

getDirectionality

public final org.opentrafficsim.core.network.LongitudinalDirectionality getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType)

Parameters:

gtuType - the GTU type to provide the directionality for

Returns:

directionality.

getGtuList

public final List<LaneBasedGTU> getGtuList()

Returns:

gtuList.

getZ

protected double getZ()

Specified by:

getZ in class CrossSectionElement

Returns:

the z-offset for drawing (what's on top, what's underneath).

getOvertakingConditions

public final OvertakingConditions getOvertakingConditions()

Returns:

overtakingConditions

toString

public final String toString()

Overrides:

toString in class CrossSectionElement

hashCode

public int hashCode()

Overrides:

hashCode in class CrossSectionElement

equals

public boolean equals(Object obj)

Overrides:

equals in class CrossSectionElement