org.opentrafficsim.core.gtu.drivercharacteristics

Class BehavioralCharacteristics

java.lang.Object

org.opentrafficsim.core.gtu.drivercharacteristics.BehavioralCharacteristics

public class BehavioralCharacteristics
extends Object

In this class a list of behavioral characteristics in the form of parameters can be stored for use in behavioral models.

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.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Mar 24, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
BehavioralCharacteristics()

Method Summary

Modifier and Type	Method and Description
boolean	contains(AbstractParameterType<?> parameterType) Whether the given parameter type has been set.
org.djunits.value.vdouble.scalar.Acceleration	getAccelerationParameter(ParameterType<org.djunits.value.vdouble.scalar.Acceleration> parameterType) Get parameter of given type.
org.djunits.value.vdouble.scalar.Frequency	getFrequencyParameter(ParameterType<org.djunits.value.vdouble.scalar.Frequency> parameterType) Get parameter of given type.
org.djunits.value.vdouble.scalar.Length.Rel	getLengthParameter(ParameterType<org.djunits.value.vdouble.scalar.Length.Rel> parameterType) Get parameter of given type.
org.djunits.value.vdouble.scalar.LinearDensity	getLinearDensityParameter(ParameterType<org.djunits.value.vdouble.scalar.LinearDensity> parameterType) Get parameter of given type.
<U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>> org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>	getParameter(ParameterType<T> parameterType) Get parameter of given type.
boolean	getParameter(ParameterTypeBoolean parameterType) Get parameter of given type.
double	getParameter(ParameterTypeDouble parameterType) Get parameter of given type.
int	getParameter(ParameterTypeInteger parameterType) Get parameter of given type.
Map<AbstractParameterType<?>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>	getParameters() Returns a safe copy of the parameters.
org.djunits.value.vdouble.scalar.Speed	getSpeedParameter(ParameterType<org.djunits.value.vdouble.scalar.Speed> parameterType) Get parameter of given type.
org.djunits.value.vdouble.scalar.Time.Rel	getTimeParameter(ParameterType<org.djunits.value.vdouble.scalar.Time.Rel> parameterType) Get parameter of given type.
void	resetParameter(AbstractParameterType<?> parameterType) Resets the parameter value to the value from before the last set.
<U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>> void	setParameter(ParameterType<T> parameterType, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U> value) Set parameter value of given parameter type.
void	setParameter(ParameterTypeBoolean parameterType, boolean value) Set parameter value of given parameter type.
void	setParameter(ParameterTypeDouble parameterType, double value) Set parameter value of given parameter type.
void	setParameter(ParameterTypeInteger parameterType, int value) Set parameter value of given parameter type.

Methods inherited from class java.lang.Object

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

Constructor Detail

BehavioralCharacteristics

public BehavioralCharacteristics()

Method Detail

setParameter

public final <U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>> void setParameter(ParameterType<T> parameterType,
                                                                                                                                   org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U> value)
                                                                                                                            throws ParameterException

Set parameter value of given parameter type.

Type Parameters:

U - Class of unit.

T - Class of value.

Parameters:

parameterType - Parameter type.

value - Value.

Throws:

ParameterException - If the value does not comply with value type constraints.

setParameter

public final void setParameter(ParameterTypeBoolean parameterType,
                               boolean value)

Set parameter value of given parameter type.

Parameters:

parameterType - Parameter type.

value - Value.

setParameter

public final void setParameter(ParameterTypeDouble parameterType,
                               double value)
                        throws ParameterException

Set parameter value of given parameter type.

Parameters:

parameterType - Parameter type.

value - Value.

Throws:

ParameterException - If the value does not comply with value type constraints.

setParameter

public final void setParameter(ParameterTypeInteger parameterType,
                               int value)
                        throws ParameterException

Set parameter value of given parameter type.

Parameters:

parameterType - Parameter type.

value - Value.

Throws:

ParameterException - If the value does not comply with value type constraints.

resetParameter

public final void resetParameter(AbstractParameterType<?> parameterType)
                          throws ParameterException

Resets the parameter value to the value from before the last set. This goes only a single value back.

Parameters:

parameterType - Parameter type.

Throws:

ParameterException - If the parameter was never set.

getParameter

public final <U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>> org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U> getParameter(ParameterType<T> parameterType)
                                                                                                                                                                            throws ParameterException

Get parameter of given type.

Type Parameters:

U - Class of unit.

T - Class of value.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getParameter

public final boolean getParameter(ParameterTypeBoolean parameterType)
                           throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getParameter

public final int getParameter(ParameterTypeInteger parameterType)
                       throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getParameter

public final double getParameter(ParameterTypeDouble parameterType)
                          throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getSpeedParameter

public final org.djunits.value.vdouble.scalar.Speed getSpeedParameter(ParameterType<org.djunits.value.vdouble.scalar.Speed> parameterType)
                                                               throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getAccelerationParameter

public final org.djunits.value.vdouble.scalar.Acceleration getAccelerationParameter(ParameterType<org.djunits.value.vdouble.scalar.Acceleration> parameterType)
                                                                             throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getTimeParameter

public final org.djunits.value.vdouble.scalar.Time.Rel getTimeParameter(ParameterType<org.djunits.value.vdouble.scalar.Time.Rel> parameterType)
                                                                 throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getLengthParameter

public final org.djunits.value.vdouble.scalar.Length.Rel getLengthParameter(ParameterType<org.djunits.value.vdouble.scalar.Length.Rel> parameterType)
                                                                     throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getFrequencyParameter

public final org.djunits.value.vdouble.scalar.Frequency getFrequencyParameter(ParameterType<org.djunits.value.vdouble.scalar.Frequency> parameterType)
                                                                       throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

getLinearDensityParameter

public final org.djunits.value.vdouble.scalar.LinearDensity getLinearDensityParameter(ParameterType<org.djunits.value.vdouble.scalar.LinearDensity> parameterType)
                                                                               throws ParameterException

Get parameter of given type.

Parameters:

parameterType - Parameter type.

Returns:

Parameter of given type.

Throws:

ParameterException - If parameter was never set.

contains

public final boolean contains(AbstractParameterType<?> parameterType)

Whether the given parameter type has been set.

Parameters:

parameterType - Parameter type.

Returns:

Whether the given parameter type has been set.

getParameters

public final Map<AbstractParameterType<?>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>> getParameters()

Returns a safe copy of the parameters.

Returns:

Safe copy of the parameters, e.g., for printing.