org.opentrafficsim.road.gtu.lane.tactical.directedlanechange

Interface DirectedLaneChangeModel

All Known Implementing Classes:

AbstractDirectedLaneChangeModel, DirectedAltruistic, DirectedEgoistic, DirectedFixedLaneChangeModel

public interface DirectedLaneChangeModel

All directed lane change models must implement this interface. A directed lane change model is a lane change model where the choice for a lateral direction has already been made.

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 3 nov. 2014

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
DirectedLaneMovementStep	computeLaneChangeAndAcceleration(LaneBasedGTU gtu, org.opentrafficsim.core.network.LateralDirectionality direction, Collection<HeadwayGTU> sameLaneTraffic, Collection<HeadwayGTU> otherLaneTraffic, org.djunits.value.vdouble.scalar.Length.Rel maxDistance, org.djunits.value.vdouble.scalar.Speed speedLimit, org.djunits.value.vdouble.scalar.Acceleration otherLaneRouteIncentive, org.djunits.value.vdouble.scalar.Acceleration laneChangeThreshold, org.djunits.value.vdouble.scalar.Time.Rel laneChangeTime) Compute the acceleration and lane change.
String	getLongName() Return complete textual information about this instantiation of this GTU following model.
String	getName() Return the name of this GTU following model.

Method Detail

computeLaneChangeAndAcceleration

DirectedLaneMovementStep computeLaneChangeAndAcceleration(LaneBasedGTU gtu,
                                                          org.opentrafficsim.core.network.LateralDirectionality direction,
                                                          Collection<HeadwayGTU> sameLaneTraffic,
                                                          Collection<HeadwayGTU> otherLaneTraffic,
                                                          org.djunits.value.vdouble.scalar.Length.Rel maxDistance,
                                                          org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                          org.djunits.value.vdouble.scalar.Acceleration otherLaneRouteIncentive,
                                                          org.djunits.value.vdouble.scalar.Acceleration laneChangeThreshold,
                                                          org.djunits.value.vdouble.scalar.Time.Rel laneChangeTime)
                                                   throws org.opentrafficsim.core.gtu.GTUException

Compute the acceleration and lane change.

Parameters:

gtu - GTU; the GTU for which the acceleration and lane change is computed

direction - the direction of the lane we want to change to

sameLaneTraffic - Collection<HeadwayGTU>; the set of information about observable GTUs in the current lane (can not be null and may include the gtu)

otherLaneTraffic - Collection<HeadwayGTU>; the set of information about observable GTUs in the adjacent lane where GTUs should drive in the absence of other traffic (must be null if there is no such lane)

maxDistance - the maximum distance that the current GTU can drive, e.g. due to a lane drop

speedLimit - Speed; the local speed limit

otherLaneRouteIncentive - Acceleration; route incentive to merge to the adjacent lane where GTUs should drive in the absence of other traffic

laneChangeThreshold - Acceleration; threshold that prevents lane changes that have very little benefit merge to overtake other traffic

laneChangeTime - time spent to overtake

Returns:

LaneMovementStep; the result of the lane change and GTU following model

Throws:

org.opentrafficsim.core.gtu.GTUException - when the position of the GTU on the lane(s) cannot be determined

getName

String getName()

Return the name of this GTU following model.

Returns:

String; just the name of the GTU following model

getLongName

String getLongName()

Return complete textual information about this instantiation of this GTU following model.

Returns:

String; the name and parameter values of the GTU following model