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

Class LaneOperationalPlanBuilder.LaneChange

java.lang.Object

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

All Implemented Interfaces:

Serializable

Enclosing class:

LaneOperationalPlanBuilder

public static class LaneOperationalPlanBuilder.LaneChange
extends Object
implements Serializable

Lane change status across operational plans.

Copyright (c) 2013-2016 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

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.
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	setLaneChangeDirectionality(org.opentrafficsim.core.network.LateralDirectionality laneChangeDirectionality)
void	setLaneChangeDuration(org.djunits.value.vdouble.scalar.Duration laneChangeDuration) Sets the duration for a lane change.
String	toString()
(package private) double	updateAndGetFraction(org.djunits.value.vdouble.scalar.Duration timeStep, org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection, LaneBasedGTU gtu) Update the lane change and return the lateral fraction for the end of the coming time step.

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneChange

public LaneChange()

Method Detail

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

setLaneChangeDirectionality

public final void setLaneChangeDirectionality(org.opentrafficsim.core.network.LateralDirectionality laneChangeDirectionality)

Parameters:

laneChangeDirectionality - set laneChangeDirectionality.

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; gtu

Returns:

target lane of lane change

Throws:

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

setLaneChangeDuration

public final void setLaneChangeDuration(org.djunits.value.vdouble.scalar.Duration laneChangeDuration)

Sets the duration for a lane change. May be set during a lane change. Whenever the lane change progress exceeds the lane change duration, the lane change is finalized in the next time step.

Parameters:

laneChangeDuration - total lane change duration

updateAndGetFraction

final double updateAndGetFraction(org.djunits.value.vdouble.scalar.Duration timeStep,
                                  org.opentrafficsim.core.network.LateralDirectionality laneChangeDirection,
                                  LaneBasedGTU gtu)

Update the lane change and return the lateral fraction for the end of the coming time step. This method is for use by the operational plan builder. It adds the time step duration to the lane change progress. Lane changes are automatically initiated and finalized.

Parameters:

timeStep - coming time step duration

laneChangeDirection - direction of lane change

gtu - GTU

Returns:

lateral fraction for the end of the coming time step

toString

public final String toString()

Overrides:

toString in class Object