org.opentrafficsim.core.gtu.behavioralcharacteristics

Class BehavioralCharacteristics

java.lang.Object

org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics

All Implemented Interfaces:

Serializable

public class BehavioralCharacteristics
extends Object
implements Serializable

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

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 13, 2016

Author:

Alexander Verbraeck, Wouter Schakel

See Also:

Serialized Form

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.
<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> T	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.DoubleScalarInterface>	getParameters() Returns a safe copy of the parameters.
void	resetParameter(AbstractParameterType<?> parameterType) Resets the parameter value to the value from before the last set.
void	setAll(BehavioralCharacteristics behavioralCharacteristics) Sets all behavioral characteristics from the given set in this set.
<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> BehavioralCharacteristics	setDefaultParameter(AbstractParameterType<T> parameter) Sets the default value of a parameter.
BehavioralCharacteristics	setDefaultParameters(Class<?> clazz) Sets the default values of all accessible parameters defined in the given class.
<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> void	setParameter(ParameterType<T> parameterType, T 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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BehavioralCharacteristics

public BehavioralCharacteristics()

Method Detail

setParameter

public final <T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> void setParameter(ParameterType<T> parameterType,
                                                                                                  T value)
                                                                                           throws ParameterException

Set parameter value of given parameter type.

Type Parameters:

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 <T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> T getParameter(ParameterType<T> parameterType)
                                                                                  throws ParameterException

Get parameter of given type.

Type Parameters:

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.

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.DoubleScalarInterface> getParameters()

Returns a safe copy of the parameters.

Returns:

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

setDefaultParameter

public final <T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> BehavioralCharacteristics setDefaultParameter(AbstractParameterType<T> parameter)
                                                                                                                       throws ParameterException

Sets the default value of a parameter.

Type Parameters:

T - Class of the value.

Parameters:

parameter - parameter to set the default value of

Returns:

this set of behavioral characteristics (for method chaining)

Throws:

ParameterException - if the parameter type has no default value

setDefaultParameters

public final BehavioralCharacteristics setDefaultParameters(Class<?> clazz)

Sets the default values of all accessible parameters defined in the given class.

Parameters:

clazz - class with parameters

Returns:

this set of behavioral characteristics (for method chaining)

setAll

public final void setAll(BehavioralCharacteristics behavioralCharacteristics)

Sets all behavioral characteristics from the given set in this set.

Parameters:

behavioralCharacteristics - set of behavioral characteristics to include in this set

toString

public final String toString()

Overrides:

toString in class Object