org.opentrafficsim.road.gtu.lane.tactical.lanechangemobil

Interface LaneChangeModel

All Known Implementing Classes:

AbstractLaneChangeModel, Altruistic, Egoistic, FixedLaneChangeModel

public interface LaneChangeModel

All lane change models must implement this interface.
TODO: Lane change models should use the perceived nearby GTUs rather than a provided list of same lane traffic, etc.

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
LaneMovementStep	computeLaneChangeAndAcceleration(LaneBasedGTU gtu, Collection<HeadwayGTU> sameLaneTraffic, Collection<HeadwayGTU> rightLaneTraffic, Collection<HeadwayGTU> leftLaneTraffic, org.djunits.value.vdouble.scalar.Speed speedLimit, org.djunits.value.vdouble.scalar.Acceleration preferredLaneRouteIncentive, org.djunits.value.vdouble.scalar.Acceleration laneChangeThreshold, org.djunits.value.vdouble.scalar.Acceleration nonPreferredLaneRouteIncentive) 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

LaneMovementStep computeLaneChangeAndAcceleration(LaneBasedGTU gtu,
                                                  Collection<HeadwayGTU> sameLaneTraffic,
                                                  Collection<HeadwayGTU> rightLaneTraffic,
                                                  Collection<HeadwayGTU> leftLaneTraffic,
                                                  org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                  org.djunits.value.vdouble.scalar.Acceleration preferredLaneRouteIncentive,
                                                  org.djunits.value.vdouble.scalar.Acceleration laneChangeThreshold,
                                                  org.djunits.value.vdouble.scalar.Acceleration nonPreferredLaneRouteIncentive)
                                           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

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

rightLaneTraffic - Collection<GTU>; the set of 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)

leftLaneTraffic - Collection<GTU>; the set of observable GTUs in the adjacent lane into which GTUs should merge to overtake other traffic (must be null if there is no such lane)

speedLimit - DoubleScalarAbs<SpeedUnit>; the local speed limit

preferredLaneRouteIncentive - 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

nonPreferredLaneRouteIncentive - Acceleration; route incentive to merge to the adjacent lane into which GTUs should merge to overtake other traffic

Returns:

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

Throws:

org.opentrafficsim.core.gtu.GTUException - when the speed of the GTU can not 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