org.opentrafficsim.core.gtu.lane

Class LaneBlock

java.lang.Object

org.opentrafficsim.core.gtu.AbstractGTU

org.opentrafficsim.core.gtu.lane.LaneBlock

All Implemented Interfaces:

Serializable, LocatableInterface, org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, GTU, LaneBasedGTU, OTS_SCALAR

public class LaneBlock
extends AbstractGTU
implements LaneBasedGTU

Special GTU that cannot move, but it can be seen by other GTUs.

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: 1378 $, $LastChangedDate: 2015-09-03 13:38:01 +0200 (Thu, 03 Sep 2015) $, by $Author: averbraeck $, initial version 15 jul. 2015

Author:

Alexander Verbraeck, Peter Knoppers

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

Modifier and Type	Field and Description
static GTUType	BLOCK_GTU blocking GTU type.

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
LaneBlock(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel position, OTSDEVSSimulatorInterface simulator, Class<? extends Renderable2D> animationClass)

Method Summary

Modifier and Type	Method and Description
Lane	bestAccessibleAdjacentLane(Lane currentLane, LateralDirectionality lateralDirection, org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition) Determine whether there is a lane to the left or to the right of this lane, which is accessible from this lane, or null if no lane could be found.
org.djunits.value.vdouble.scalar.Time.Rel	deltaTimeForDistance(org.djunits.value.vdouble.scalar.Length.Rel distance) Determine the time since last evaluation when this GTU has covered the specified distance from the position of the last evaluation time.
void	destroy() destroy the vehicle from the simulation and animation.
void	enterLane(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel position) insert GTU at a certain position.
double	fractionalPosition(Lane lane, 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, 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(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(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.
org.djunits.value.vdouble.scalar.Acceleration.Abs	getAcceleration()
org.djunits.value.vdouble.scalar.Acceleration.Abs	getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs when)
Bounds	getBounds()
RelativePosition	getFront()
GTUFollowingModel	getGTUFollowingModel() Retrieve the GTU following model of this LaneBasedGTU.
Lane	getLane()
LaneChangeUrgeGTUColorer.LaneChangeDistanceAndDirection	getLaneChangeDistanceAndDirection() Return the distance available for the next needed lane change and the lateral direction of that lane change.
org.djunits.value.vdouble.scalar.Time.Abs	getLastEvaluationTime()
org.djunits.value.vdouble.scalar.Speed.Abs	getLateralVelocity()
org.djunits.value.vdouble.scalar.Length.Rel	getLength()
DirectedPoint	getLocation()
org.djunits.value.vdouble.scalar.Speed.Abs	getLongitudinalVelocity() v(t) = v0 + (t - t0) * a.
org.djunits.value.vdouble.scalar.Speed.Abs	getLongitudinalVelocity(org.djunits.value.vdouble.scalar.Time.Abs when) Return the speed of this GTU at the specified time.
org.djunits.value.vdouble.scalar.Speed.Abs	getMaximumVelocity()
org.djunits.value.vdouble.scalar.Time.Abs	getNextEvaluationTime()
org.djunits.value.vdouble.scalar.Length.Abs	getOdometer() Retrieve the odometer value.
RelativePosition	getRear()
Map<RelativePosition.TYPE,RelativePosition>	getRelativePositions()
OTSDEVSSimulatorInterface	getSimulator()
org.djunits.value.vdouble.scalar.Speed.Abs	getVelocity()
org.djunits.value.vdouble.scalar.Length.Rel	getWidth()
HeadwayGTU	headway(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel maxDistance) Determine by what distance the front of this GTU is behind the rear an other GTU, or the rear of this GTU is ahead of the front of an other GTU.
HeadwayGTU	headway(org.djunits.value.vdouble.scalar.Length.Rel maxDistance) Determine which GTU in front of this GTU, or behind this GTU.
void	leaveLane(Lane lane) Unregister the GTU from a lane.
Set<LaneBasedGTU>	parallel(Lane lane, org.djunits.value.vdouble.scalar.Time.Abs when) Determine which GTUs are parallel with us on another lane, based on fractional positions.
Set<LaneBasedGTU>	parallel(LateralDirectionality lateralDirection, org.djunits.value.vdouble.scalar.Time.Abs when) Determine which GTUs are parallel with us in a certain lateral direction, based on fractional positions.
org.djunits.value.vdouble.scalar.Length.Rel	position(Lane lane, 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, 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(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(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, 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.
org.djunits.value.vdouble.scalar.Time.Abs	timeAtDistance(org.djunits.value.vdouble.scalar.Length.Rel distance) Determine the time when this GTU will have covered the specified distance from the position of the last evaluation time.
String	toString()

Methods inherited from class org.opentrafficsim.core.gtu.AbstractGTU

getGTUType, getId, getReference, getRouteNavigator, setRouteNavigator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getGTUType, getId, getReference

Field Detail

BLOCK_GTU

public static final GTUType BLOCK_GTU

blocking GTU type.

Constructor Detail

LaneBlock

public LaneBlock(Lane lane,
                 org.djunits.value.vdouble.scalar.Length.Rel position,
                 OTSDEVSSimulatorInterface simulator,
                 Class<? extends Renderable2D> animationClass)
          throws GTUException,
                 RemoteException,
                 NetworkException,
                 NamingException

Parameters:

lane - The lane where the block has to be put

position - the position on the lane as a length

simulator - the simulator to avoid NullPointerExceptions

animationClass - Class<? extends Renderable2D>; the class for animation or null if no animation

Throws:

GTUException - when GTU cannot be created.

NamingException - if an error occurs when adding the animation handler

RemoteException - when the simulator cannot be reached

NetworkException - when the GTU cannot be placed on the given lane

Method Detail

getLane

public final Lane getLane()

Returns:

lane

getLength

public final org.djunits.value.vdouble.scalar.Length.Rel getLength()

Specified by:

getLength in interface GTU

Returns:

the maximum length of the GTU (parallel with driving direction).

getWidth

public final org.djunits.value.vdouble.scalar.Length.Rel getWidth()

Specified by:

getWidth in interface GTU

Returns:

the maximum width of the GTU (perpendicular to driving direction).

getMaximumVelocity

public final org.djunits.value.vdouble.scalar.Speed.Abs getMaximumVelocity()

Specified by:

getMaximumVelocity in interface GTU

Returns:

the maximum velocity of the GTU, in the linear direction

getSimulator

public final OTSDEVSSimulatorInterface getSimulator()

Specified by:

getSimulator in interface GTU

Returns:

the simulator of the GTU.

getFront

public final RelativePosition getFront()

Specified by:

getFront in interface GTU

Returns:

the front position of the GTU, relative to its reference point.

getRear

public final RelativePosition getRear()

Specified by:

getRear in interface GTU

Returns:

the rear position of the GTU, relative to its reference point.

getVelocity

public final org.djunits.value.vdouble.scalar.Speed.Abs getVelocity()
                                                             throws RemoteException

Specified by:

getVelocity in interface GTU

Returns:

the current velocity of the GTU, combining longitudinal, lateral and vertical speed components.

Throws:

RemoteException - on communications failure

getRelativePositions

public final Map<RelativePosition.TYPE,RelativePosition> getRelativePositions()

Specified by:

getRelativePositions in interface GTU

Returns:

the positions for this GTU.

destroy

public final void destroy()

destroy the vehicle from the simulation and animation.

Specified by:

destroy in interface GTU

getAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration.Abs getAcceleration()
                                                                        throws RemoteException

Specified by:

getAcceleration in interface GTU

Specified by:

getAcceleration in interface LaneBasedGTU

Returns:

the acceleration (or deceleration) of the GTU, in the direction of the lane

Throws:

RemoteException - in case of problems getting the simulation time.

getLocation

public final DirectedPoint getLocation()
                                throws RemoteException

Specified by:

getLocation in interface LocatableInterface

Throws:

RemoteException

getBounds

public final Bounds getBounds()
                       throws RemoteException

Specified by:

getBounds in interface LocatableInterface

Throws:

RemoteException

getOdometer

public final org.djunits.value.vdouble.scalar.Length.Abs getOdometer()
                                                              throws RemoteException

Retrieve the odometer value.

Specified by:

getOdometer in interface GTU

Returns:

DoubleScalar.Abs<LengthUnit>; the current odometer value

Throws:

RemoteException - on communications failure

getLongitudinalVelocity

public final org.djunits.value.vdouble.scalar.Speed.Abs getLongitudinalVelocity()
                                                                         throws RemoteException

v(t) = v0 + (t - t0) * a.

Specified by:

getLongitudinalVelocity in interface LaneBasedGTU

Returns:

the velocity of the GTU, in the direction of the lane

Throws:

RemoteException - in case of problems getting the simulation time.

getLongitudinalVelocity

public final org.djunits.value.vdouble.scalar.Speed.Abs getLongitudinalVelocity(org.djunits.value.vdouble.scalar.Time.Abs when)

Return the speed of this GTU at the specified time.
v(t) = v0 + (t - t0) * a

Specified by:

getLongitudinalVelocity in interface LaneBasedGTU

Parameters:

when - time for which the speed must be returned

Returns:

DoubleScalarAbs<SpeedUnit>; the speed at the specified time

getAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration.Abs getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs when)

Specified by:

getAcceleration in interface LaneBasedGTU

Parameters:

when - time for which the speed must be returned

Returns:

the acceleration (or deceleration) of the GTU, in the direction of the lane.

getLateralVelocity

public final org.djunits.value.vdouble.scalar.Speed.Abs getLateralVelocity()

Specified by:

getLateralVelocity in interface LaneBasedGTU

Returns:

the velocity of the GTU, perpendicular to the direction of the lane. Positive lateral velocity is "left" compared to the driving direction.

getLastEvaluationTime

public final org.djunits.value.vdouble.scalar.Time.Abs getLastEvaluationTime()

Specified by:

getLastEvaluationTime in interface LaneBasedGTU

Returns:

DoubleScalarAbs<TimeUnit>; the time of last evaluation.

getNextEvaluationTime

public final org.djunits.value.vdouble.scalar.Time.Abs getNextEvaluationTime()

Specified by:

getNextEvaluationTime in interface LaneBasedGTU

Returns:

DoubleScalarAbs<TimeUnit>; the time of next evaluation.

enterLane

public final void enterLane(Lane lane,
                            org.djunits.value.vdouble.scalar.Length.Rel position)
                     throws NetworkException

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.

Specified by:

enterLane in interface LaneBasedGTU

Parameters:

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

position - the position on the lane.

Throws:

NetworkException - on network inconsistency

leaveLane

public final void leaveLane(Lane lane)

Unregister the GTU from a lane.

Specified by:

leaveLane in interface LaneBasedGTU

Parameters:

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

positions

public final Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> positions(RelativePosition relativePosition)
                                                                      throws NetworkException,
                                                                             RemoteException

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.

Specified by:

positions in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on one of the lanes on which it is registered.

RemoteException - when simulator time cannot be retrieved.

positions

public final Map<Lane,org.djunits.value.vdouble.scalar.Length.Rel> positions(RelativePosition relativePosition,
                                                                             org.djunits.value.vdouble.scalar.Time.Abs when)
                                                                      throws NetworkException,
                                                                             RemoteException

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.

Specified by:

positions in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on one of the lanes on which it is registered.

RemoteException - on communications failure

position

public final org.djunits.value.vdouble.scalar.Length.Rel position(Lane lane,
                                                                  RelativePosition relativePosition)
                                                           throws NetworkException,
                                                                  RemoteException

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

Specified by:

position in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on the given lane.

RemoteException - when simulator time cannot be retrieved.

position

public final org.djunits.value.vdouble.scalar.Length.Rel position(Lane lane,
                                                                  RelativePosition relativePosition,
                                                                  org.djunits.value.vdouble.scalar.Time.Abs when)
                                                           throws NetworkException,
                                                                  RemoteException

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

Specified by:

position in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on the given lane.

RemoteException - on communications failure

fractionalPositions

public final Map<Lane,Double> fractionalPositions(RelativePosition relativePosition)
                                           throws NetworkException,
                                                  RemoteException

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.

Specified by:

fractionalPositions in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on one of the lanes on which it is registered.

RemoteException - when simulator time cannot be retrieved.

fractionalPositions

public Map<Lane,Double> fractionalPositions(RelativePosition relativePosition,
                                            org.djunits.value.vdouble.scalar.Time.Abs when)
                                     throws NetworkException,
                                            RemoteException

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.

Specified by:

fractionalPositions in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on one of the lanes on which it is registered.

RemoteException - on communications failure

fractionalPosition

public double fractionalPosition(Lane lane,
                                 RelativePosition relativePosition,
                                 org.djunits.value.vdouble.scalar.Time.Abs when)
                          throws NetworkException,
                                 RemoteException

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.

Specified by:

fractionalPosition in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on the given lane.

RemoteException - on communications failure

fractionalPosition

public double fractionalPosition(Lane lane,
                                 RelativePosition relativePosition)
                          throws NetworkException,
                                 RemoteException

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.

Specified by:

fractionalPosition in interface LaneBasedGTU

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:

NetworkException - when the vehicle is not on the given lane.

RemoteException - when simulator time cannot be retrieved.

projectedPosition

public org.djunits.value.vdouble.scalar.Length.Rel projectedPosition(Lane projectionLane,
                                                                     RelativePosition relativePosition,
                                                                     org.djunits.value.vdouble.scalar.Time.Abs when)
                                                              throws NetworkException,
                                                                     RemoteException

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

Specified by:

projectedPosition in interface LaneBasedGTU

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

Returns:

DoubleScalar.Rel<LengthUnit>; the position of this GTU in the projectionLane

Throws:

NetworkException - when projectionLane it not in any of the CrossSectionLink that the GTU is on

RemoteException - on communications failure

headway

public HeadwayGTU headway(org.djunits.value.vdouble.scalar.Length.Rel maxDistance)
                   throws RemoteException,
                          NetworkException

Determine which GTU in front of this GTU, or behind this GTU. This method looks in all lanes where this GTU is registered, and not further than the absolute value of the given maxDistance. The minimum headway is returned of all Lanes where the GTU is registered. When no GTU is found within the given maxDistance, null is returned. The search will extend into successive lanes if the maxDistance is larger than the remaining length on the lane. When Lanes (or underlying CrossSectionLinks) diverge, the headway algorithms have to look at multiple Lanes and return the minimum headway in each of the Lanes. When the Lanes (or underlying CrossSectionLinks) converge, "parallel" traffic is not taken into account in the headway calculation. Instead, gap acceptance algorithms or their equivalent should guide the merging behavior.
Note: Headway is the net headway and calculated on a front-to-back basis.

Specified by:

headway in interface LaneBasedGTU

Parameters:

maxDistance - the maximum distance to look for the nearest GTU; positive values search forwards; negative values search backwards

Returns:

HeadwayGTU; the headway and the GTU

Throws:

RemoteException - when simulator time cannot be retrieved.

NetworkException - when there is an error with the next lanes in the network.

headway

public HeadwayGTU headway(Lane lane,
                          org.djunits.value.vdouble.scalar.Length.Rel maxDistance)
                   throws RemoteException,
                          NetworkException

Determine by what distance the front of this GTU is behind the rear an other GTU, or the rear of this GTU is ahead of the front of an other GTU. Only positive values are returned. This method only looks in the given lane, and not further than the given maxDistance. When no vehicle is found within the given maxDistance, new DoubleScalar.Rel<LengthUnit>(Double.MAX_VALUE, METER) is returned. The search will extend into successive lanes if the maxDistance is larger than the length of the lane.
Note: Headway is the net headway and calculated on a front-to-back basis.

Specified by:

headway in interface LaneBasedGTU

Parameters:

lane - the lane to look for another GTU

maxDistance - the maximum distance to look for; if positive, the search is forwards; if negative, the search is backwards

Returns:

HeadwayGTU; the headway and the GTU

Throws:

RemoteException - when simulator time cannot be retrieved

NetworkException - when the vehicle's route is inconclusive or vehicles are not registered correctly on their lanes

parallel

public Set<LaneBasedGTU> parallel(Lane lane,
                                  org.djunits.value.vdouble.scalar.Time.Abs when)
                           throws RemoteException,
                                  NetworkException

Determine which GTUs are parallel with us on another lane, based on fractional positions.
Note: When the GTU that calls the method is also registered on the given lane, it is excluded from the return set.

Specified by:

parallel in interface LaneBasedGTU

Parameters:

lane - the lane to look for parallel (partial or full overlapping) GTUs.

when - the future time for which to calculate the headway

Returns:

the set of GTUs parallel to us on the other lane (partial overlap counts as parallel), based on fractional positions, or an empty set when no GTUs were found.

Throws:

RemoteException - when simulator time cannot be retrieved.

NetworkException - when the vehicle's route is inconclusive, when vehicles are not registered correctly on their lanes, or when the given lane is not parallel to one of the lanes where we are registered.

parallel

public Set<LaneBasedGTU> parallel(LateralDirectionality lateralDirection,
                                  org.djunits.value.vdouble.scalar.Time.Abs when)
                           throws RemoteException,
                                  NetworkException

Determine which GTUs are parallel with us in a certain lateral direction, based on fractional positions.
Note 1: This method will look to the adjacent lanes of all lanes where the vehicle has been registered.
Note 2: When the GTU that calls the method is also registered on the given lane, it is excluded from the return set.

Specified by:

parallel in interface LaneBasedGTU

Parameters:

lateralDirection - the direction of the adjacent lane(s) to look for parallel (partial or full overlapping) GTUs.

when - the future time for which to calculate the headway

Returns:

the set of GTUs parallel to us on other lane(s) in the given direction (partial overlap counts as parallel), based on fractional positions, or an empty set when no GTUs were found.

Throws:

RemoteException - when simulator time cannot be retrieved.

NetworkException - when the vehicle's route is inconclusive, when vehicles are not registered correctly on their lanes, or when there are no lanes parallel to one of the lanes where we are registered in the given direction.

bestAccessibleAdjacentLane

public Lane bestAccessibleAdjacentLane(Lane currentLane,
                                       LateralDirectionality lateralDirection,
                                       org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition)

Determine whether there is a lane to the left or to the right of this lane, which is accessible from this lane, or null 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, null will be returned.
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.
The algorithm also looks for RoadMarkerAcross elements between the lanes to determine the lateral permeability for a GTU. A RoadMarkerAcross is seen as being between two lanes if its center line is not more than delta distance from the relevant lateral edges of the two adjacent lanes.
When there are multiple lanes that are adjacent, which could e.g. be the case if an overlapping tram lane and a car lane are adjacent to the current lane, the widest lane that best matches the GTU accessibility of the provided GTUType is returned.
Note: LEFT is seen as a negative lateral direction, RIGHT as a positive lateral direction.

Specified by:

bestAccessibleAdjacentLane in interface LaneBasedGTU

Parameters:

currentLane - the lane to look for the best accessible adjacent lane

lateralDirection - the direction (LEFT, RIGHT) to look at

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the position of the GTU along this Lane

Returns:

the lane if it is accessible, or null if there is no lane, it is not accessible, or the driving direction does not match.

timeAtDistance

public org.djunits.value.vdouble.scalar.Time.Abs timeAtDistance(org.djunits.value.vdouble.scalar.Length.Rel distance)

Determine the time when this GTU will have covered the specified distance from the position of the last evaluation time.

Specified by:

timeAtDistance in interface LaneBasedGTU

Parameters:

distance - DoubleScalar.Rel<LengthUnit>; the distance

Returns:

DoubleScalar.Rel<TimeUnit>; the time, or null if this GTU stops before covering the specified distance

deltaTimeForDistance

public org.djunits.value.vdouble.scalar.Time.Rel deltaTimeForDistance(org.djunits.value.vdouble.scalar.Length.Rel distance)

Determine the time since last evaluation when this GTU has covered the specified distance from the position of the last evaluation time.

Specified by:

deltaTimeForDistance in interface LaneBasedGTU

Parameters:

distance - DoubleScalar.Rel<LengthUnit>; the distance

Returns:

DoubleScalar.Rel<TimeUnit>; the time difference from last evaluation or null if this GTU stops before covering the specified distance

getGTUFollowingModel

public GTUFollowingModel getGTUFollowingModel()

Retrieve the GTU following model of this LaneBasedGTU.

Specified by:

getGTUFollowingModel in interface LaneBasedGTU

Returns:

GTUFollowingModel

getLaneChangeDistanceAndDirection

public LaneChangeUrgeGTUColorer.LaneChangeDistanceAndDirection getLaneChangeDistanceAndDirection()

Return the distance available for the next needed lane change and the lateral direction of that lane change.

Specified by:

getLaneChangeDistanceAndDirection in interface LaneBasedGTU

Returns:

LaneChangeAndDirection; the available distance and lateral direction for the next required lane change

toString

public String toString()

Overrides:

toString in class Object