org.opentrafficsim.road.modelproperties

Class IDMPropertySet

java.lang.Object

org.opentrafficsim.road.modelproperties.IDMPropertySet

public final class IDMPropertySet
extends Object

Compound property for IDM or IDMPlus parameters

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2016-05-28 11:33:31 +0200 (Sat, 28 May 2016) $, @version $Revision: 2051 $, by $Author: averbraeck $, initial version 5 jan. 2015

Author:

Peter Knoppers

Method Summary

Modifier and Type	Method and Description
static Acceleration	getA(CompoundProperty set) Return the maximum acceleration.
static Acceleration	getB(CompoundProperty set) Return the maximum comfortable deceleration.
static Length	getS0(CompoundProperty set) Return the static headway.
static Duration	getTSafe(CompoundProperty set) Return the time headway.
static CompoundProperty	makeIDMPropertySet(String key, String carType, Acceleration a, Acceleration b, Length s0, Duration tSafe, int displayPriority) Create a CompoundProperty for the IDM or IDMPlus parameters for a specified car type.

Methods inherited from class java.lang.Object

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

Method Detail

makeIDMPropertySet

public static CompoundProperty makeIDMPropertySet(String key,
                                                  String carType,
                                                  Acceleration a,
                                                  Acceleration b,
                                                  Length s0,
                                                  Duration tSafe,
                                                  int displayPriority)
                                           throws PropertyException

Create a CompoundProperty for the IDM or IDMPlus parameters for a specified car type.

Parameters:

key - String; the unique key of the new property

carType - String; the type of the car

a - Acceleration; the maximum acceleration of the car

b - Acceleration; the maximum comfortable deceleration of the car

s0 - Length; the stationary distance headway

tSafe - Duration; the time headway

displayPriority - int; the display priority of the returned CompoundProperty

Returns:

CompoundProperty

Throws:

PropertyException - when key is not unique, or one of the generated sub keys is not unique

getA

public static Acceleration getA(CompoundProperty set)

Return the maximum acceleration.

Parameters:

set - CompoundProperty (should have been created with makeIDMPropertySet)

Returns:

Acceleration

getB

public static Acceleration getB(CompoundProperty set)

Return the maximum comfortable deceleration.

Parameters:

set - CompoundProperty (should have been created with makeIDMPropertySet)

Returns:

Acceleration

getS0

public static Length getS0(CompoundProperty set)

Return the static headway.

Parameters:

set - CompoundProperty (should have been created with makeIDMPropertySet)

Returns:

Length

getTSafe

public static Duration getTSafe(CompoundProperty set)

Return the time headway.

Parameters:

set - CompoundProperty (should have been created with makeIDMPropertySet)

Returns:

Time