org.opentrafficsim.road.gtu.lane.tactical.following

Interface CarFollowingModel

All Known Subinterfaces:

GTUFollowingModelOld

All Known Implementing Classes:

AbstractCarFollowingModel, AbstractGTUFollowingModelMobil, AbstractIDM, FixedAccelerationModel, IDM, IDMOld, IDMPlus, IDMPlusMulti, IDMPlusOld, SequentialFixedAccelerationModel, ToledoCarFollowing

public interface CarFollowingModel

Methods that a car-following model has to implement. The behavioral characteristics are supplied to obtain parameters. The phrase 'car-following model' is the commonly used and therefore intuitive name, but in actuality it is much more.

• Following other vehicle types: van, bus, truck.
• Following other GTU's: bicycle, pedestrian.
• Free driving.
• Approaching (theoretically different from following, usually the same formula).
• Stopping for a traffic light, intersection conflict, etc,

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 Apr 22, 2016

Author:

Alexander Verbraeck, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
org.djunits.value.vdouble.scalar.Length	desiredHeadway(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics, org.djunits.value.vdouble.scalar.Speed speed) Determines the desired headway in equilibrium conditions, i.e.
org.djunits.value.vdouble.scalar.Speed	desiredSpeed(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics, SpeedLimitInfo speedInfo) Determines the desired speed.
org.djunits.value.vdouble.scalar.Acceleration	followingAcceleration(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics, org.djunits.value.vdouble.scalar.Speed speed, SpeedLimitInfo speedLimitInfo, SortedMap<org.djunits.value.vdouble.scalar.Length,org.djunits.value.vdouble.scalar.Speed> leaders) Determination of car-following acceleration, possibly based on multiple leaders.
String	getLongName() Return the complete name of the car-following model.
String	getName() Return the name of the car-following model.

Method Detail

desiredSpeed

org.djunits.value.vdouble.scalar.Speed desiredSpeed(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics,
                                                    SpeedLimitInfo speedInfo)
                                             throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Determines the desired speed.

Parameters:

behavioralCharacteristics - behavioral characteristics

speedInfo - info regarding the desired speed for car-following

Returns:

desired speed

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter exception occurs

desiredHeadway

org.djunits.value.vdouble.scalar.Length desiredHeadway(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics,
                                                       org.djunits.value.vdouble.scalar.Speed speed)
                                                throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Determines the desired headway in equilibrium conditions, i.e. no speed difference with the leader.

Parameters:

behavioralCharacteristics - behavioral characteristics

speed - speed to determine the desired headway at

Returns:

desired headway

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter exception occurs

followingAcceleration

org.djunits.value.vdouble.scalar.Acceleration followingAcceleration(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics,
                                                                    org.djunits.value.vdouble.scalar.Speed speed,
                                                                    SpeedLimitInfo speedLimitInfo,
                                                                    SortedMap<org.djunits.value.vdouble.scalar.Length,org.djunits.value.vdouble.scalar.Speed> leaders)
                                                             throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Determination of car-following acceleration, possibly based on multiple leaders. The implementation should be able to deal with:

• The current speed being higher than the desired speed.
• The headway being negative.

Parameters:

behavioralCharacteristics - behavioral characteristics

speed - current speed

speedLimitInfo - info regarding the desired speed for car-following

leaders - set of leader headways and speeds, ordered by headway (closest first)

Returns:

car-following acceleration

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter exception occurs

getName

String getName()

Return the name of the car-following model.

Returns:

name of the car-following model

getLongName

String getLongName()

Return the complete name of the car-following model.

Returns:

complete name of the car-following model