org.opentrafficsim.road.gtu.lane.plan.operational

Class LaneChange

java.lang.Object

org.opentrafficsim.road.gtu.lane.plan.operational.LaneChange

All Implemented Interfaces:

Serializable

public class LaneChange
extends Object
implements Serializable

Lane change status across operational plans. This class allows lane based tactical planners to perform lane changes without having to deal with many complexities concerning paths and lane registration. The main purpose of the tactical planner is to request a path using getPath() for each step of the tactical planner.

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$, $LastChangedDate$, by $Author$, initial version Jul 26, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LaneChange.LaneChangePath Provides a (partial) path during lane changes.

Field Summary

Fields

Modifier and Type	Field and Description
static double	MIN_LC_LENGTH_FACTOR Minimum distance required to perform a lane change as factor on vehicle length.

Constructor Summary

Constructors

Constructor and Description
LaneChange()

Method Summary

Modifier and Type	Method and Description
org.opentrafficsim.core.network.LateralDirectionality	getDirection() Return lateral lane change direction.
double	getFraction() Returns the fraction of the lane change performed.
org.opentrafficsim.core.geometry.OTSLine3D	getPath(org.djunits.value.vdouble.scalar.Duration timeStep, LaneBasedGTU gtu, DirectedLanePosition from, nl.tudelft.simulation.language.d3.DirectedPoint startPosition, org.djunits.value.vdouble.scalar.Length planDistance, org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection) Returns the path for a lane change.
RelativeLane	getSecondLane(LaneBasedGTU gtu) Second lane of lane change relative to the reference lane.
boolean	isChangingLane() Return whether the GTU is changing lane.
boolean	isChangingLeft() Return whether the GTU is changing left.
boolean	isChangingRight() Return whether the GTU is changing right.
void	setBoundary(org.djunits.value.vdouble.scalar.Length boundary) Sets the distance within which a lane change should be finished.
void	setDesiredLaneChangeDuration(org.djunits.value.vdouble.scalar.Duration duration) Sets the desired lane change duration.
void	setLaneChangePath(LaneChange.LaneChangePath laneChangePath) Sets a lane change path.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MIN_LC_LENGTH_FACTOR

public static double MIN_LC_LENGTH_FACTOR

Minimum distance required to perform a lane change as factor on vehicle length.

Constructor Detail

LaneChange

public LaneChange()

Method Detail

setDesiredLaneChangeDuration

public void setDesiredLaneChangeDuration(org.djunits.value.vdouble.scalar.Duration duration)

Sets the desired lane change duration. Should be set by a tactical planner.

Parameters:

duration - Duration; desired lane change duration

setBoundary

public void setBoundary(org.djunits.value.vdouble.scalar.Length boundary)

Sets the distance within which a lane change should be finished. Should be set by a tactical planner. In case of a single lane change required before some point, this is not required as the found center line length is intrinsically limited. For multiple lane changes being required, space after a lane change is required.

Parameters:

boundary - DirectedPoint; boundary

getFraction

public double getFraction()

Returns the fraction of the lane change performed.

Returns:

double; fraction of lane change performed

setLaneChangePath

public void setLaneChangePath(LaneChange.LaneChangePath laneChangePath)

Sets a lane change path.

Parameters:

laneChangePath - LaneChangePath; lane change path

isChangingLane

public final boolean isChangingLane()

Return whether the GTU is changing lane.

Returns:

whether the GTU is changing lane

isChangingLeft

public final boolean isChangingLeft()

Return whether the GTU is changing left.

Returns:

whether the GTU is changing left

isChangingRight

public final boolean isChangingRight()

Return whether the GTU is changing right.

Returns:

whether the GTU is changing right

getDirection

public final org.opentrafficsim.core.network.LateralDirectionality getDirection()

Return lateral lane change direction.

Returns:

LateralDirectionality; lateral lane change direction

getSecondLane

public final RelativeLane getSecondLane(LaneBasedGTU gtu)
                                 throws org.opentrafficsim.core.gtu.plan.operational.OperationalPlanException

Second lane of lane change relative to the reference lane. Note that the reference lane may either be the source or the target lane. Thus, the second lane during a lane change may either be the left or right lane, regardless of the lane change direction.

Parameters:

gtu - LaneBasedGTU; the GTU

Returns:

target lane of lane change

Throws:

org.opentrafficsim.core.gtu.plan.operational.OperationalPlanException - If no lane change is being performed.

getPath

public final org.opentrafficsim.core.geometry.OTSLine3D getPath(org.djunits.value.vdouble.scalar.Duration timeStep,
                                                                LaneBasedGTU gtu,
                                                                DirectedLanePosition from,
                                                                nl.tudelft.simulation.language.d3.DirectedPoint startPosition,
                                                                org.djunits.value.vdouble.scalar.Length planDistance,
                                                                org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection)
                                                         throws org.opentrafficsim.core.geometry.OTSGeometryException

Returns the path for a lane change. Lane change initialization and finalization events are automatically performed.

Parameters:

timeStep - Duration; plan time step

gtu - LaneBasedGTU; gtu

from - DirectedLanePosition; current position on the from lane (i.e. not necessarily the reference position)

startPosition - DirectedPoint; current position in 2D

planDistance - Length; absolute distance that will be covered during the time step

laneChangeDirection - LateralDirectionality; lane change direction

Returns:

OTSLine3D; path

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - on path or shape error

toString

public String toString()

Overrides:

toString in class Object