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

Interface CarFollowingModel

All Known Implementing Classes:

AbstractCarFollowingModel, IDM, IDMPlus

public interface CarFollowingModel

Methods that a car-following model has to implement. The GTU is supplied to obtain characteristics such as parameters. Other input into the methods describe the car-following situation. The GTU should thus not be used to obtain: position, speed, speed limit at current location, leader, etc.

Author:

Wouter Schakel

Method Summary

Modifier and Type	Method and Description
org.djunits.value.vdouble.scalar.Length.Rel	desiredHeadway(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Speed speed) Determines the desired headway.
org.djunits.value.vdouble.scalar.Speed	desiredSpeed(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Speed speedLimit, boolean enforcement, org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed) Determines the desired speed.
org.djunits.value.vdouble.scalar.Acceleration	followingAcceleration(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Speed speedLimit, boolean enforcement, org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed, org.djunits.value.vdouble.scalar.Length.Rel headway, org.djunits.value.vdouble.scalar.Speed leaderSpeed) Determines car-following acceleration.
org.djunits.value.vdouble.scalar.Acceleration	followingAcceleration(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Speed speedLimit, boolean enforcement, org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed, SortedMap<org.djunits.value.vdouble.scalar.Length.Rel,org.djunits.value.vdouble.scalar.Speed> leaders) Multi-anticipative determination of car-following acceleration.
org.djunits.value.vdouble.scalar.Acceleration	freeAcceleration(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Speed speed, org.djunits.value.vdouble.scalar.Speed speedLimit, boolean enforcement, org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed) Determines the acceleration if there is no reason to decelerate.
String	getLongName() Return the name complete 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(LaneBasedGTU gtu,
                                                    org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                    boolean enforcement,
                                                    org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed)
                                             throws org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException

Determines the desired speed.

Parameters:

gtu - GTU for which the acceleration is calculated.

speedLimit - Speed limit, static or dynamic.

enforcement - Whether the speed limit is enforced by camera, section control, etc.

maximumVehicleSpeed - Maximum speed of the vehicle.

Returns:

Desired speed.

Throws:

org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException - If parameter exception occurs.

desiredHeadway

org.djunits.value.vdouble.scalar.Length.Rel desiredHeadway(LaneBasedGTU gtu,
                                                           org.djunits.value.vdouble.scalar.Speed speed)
                                                    throws org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException

Determines the desired headway.

Parameters:

gtu - GTU for which the acceleration is calculated.

speed - Speed to determine the desired headway at.

Returns:

Desired headway.

Throws:

org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException - If parameter exception occurs.

freeAcceleration

org.djunits.value.vdouble.scalar.Acceleration freeAcceleration(LaneBasedGTU gtu,
                                                               org.djunits.value.vdouble.scalar.Speed speed,
                                                               org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                               boolean enforcement,
                                                               org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed)
                                                        throws org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException

Determines the acceleration if there is no reason to decelerate.

Parameters:

gtu - GTU for which the acceleration is calculated.

speed - Current speed.

speedLimit - Speed limit, static or dynamic.

enforcement - Whether the speed limit is enforced by camera, section control, etc.

maximumVehicleSpeed - Maximum speed of the vehicle.

Returns:

Acceleration if there is no reason to decelerate.

Throws:

org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException - If parameter exception occurs.

followingAcceleration

org.djunits.value.vdouble.scalar.Acceleration followingAcceleration(LaneBasedGTU gtu,
                                                                    org.djunits.value.vdouble.scalar.Speed speed,
                                                                    org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                                    boolean enforcement,
                                                                    org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed,
                                                                    org.djunits.value.vdouble.scalar.Length.Rel headway,
                                                                    org.djunits.value.vdouble.scalar.Speed leaderSpeed)
                                                             throws org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException

Determines car-following acceleration. The implementation should be able to deal with:
The current speed being higher than the desired speed. The headway being negative.

Parameters:

gtu - GTU for which the acceleration is calculated.

speed - Current speed.

speedLimit - Speed limit, static or dynamic.

enforcement - Whether the speed limit is enforced by camera, section control, etc.

maximumVehicleSpeed - Maximum speed of the vehicle.

headway - Net headway towards the leading vehicle.

leaderSpeed - Speed of the leading vehicle.

Returns:

Car-following acceleration.

Throws:

org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException - If parameter exception occurs.

followingAcceleration

org.djunits.value.vdouble.scalar.Acceleration followingAcceleration(LaneBasedGTU gtu,
                                                                    org.djunits.value.vdouble.scalar.Speed speed,
                                                                    org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                                    boolean enforcement,
                                                                    org.djunits.value.vdouble.scalar.Speed maximumVehicleSpeed,
                                                                    SortedMap<org.djunits.value.vdouble.scalar.Length.Rel,org.djunits.value.vdouble.scalar.Speed> leaders)
                                                             throws org.opentrafficsim.core.gtu.drivercharacteristics.ParameterException

Multi-anticipative determination of car-following acceleration. The implementation should be able to deal with:
The current speed being higher than the desired speed. The headway being negative. The tactical planner determines whether multi-anticipative car-following is applied, including to how many leaders and within what distance, by including these vehicles in the set. The car-following model itself may however only respond to the first vehicle.

Parameters:

gtu - GTU for which the acceleration is calculated.

speed - Current speed.

speedLimit - Speed limit, static or dynamic.

enforcement - Whether the speed limit is enforced by camera, section control, etc.

maximumVehicleSpeed - Maximum speed of the vehicle.

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

Returns:

Car-following acceleration.

Throws:

org.opentrafficsim.core.gtu.drivercharacteristics.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 name complete of the car-following model.

Returns:

Complete name of the car-following model.