org.opentrafficsim.core.gtu.behavioralcharacteristics

Class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>

java.lang.Object

org.opentrafficsim.base.Type<AbstractParameterType<?>>

org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType<T>

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterType<T>

Type Parameters:

T - Class of the value.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ParameterTypeAcceleration, ParameterTypeDuration, ParameterTypeFrequency, ParameterTypeLength, ParameterTypeLinearDensity, ParameterTypeSpeed

public class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>
extends AbstractParameterType<T>
implements Serializable

Wrapper class for parameters of any quantity in JUnits.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType

AbstractParameterType.Check

Field Summary

Fields inherited from class org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType

defaultValue, valueClass

Constructor Summary

Constructors

Constructor and Description
ParameterType(String id, String description, Class<T> valueClass) Constructor without default value and check.
ParameterType(String id, String description, Class<T> valueClass, AbstractParameterType.Check check) Constructor without default value, with check.
ParameterType(String id, String description, Class<T> valueClass, T defaultValue) Constructor with default value, without check.
ParameterType(String id, String description, Class<T> valueClass, T defaultValue, AbstractParameterType.Check check) Constructor with default value and check.

Method Summary

Modifier and Type	Method and Description
void	check(T value, BehavioralCharacteristics bc) Method to overwrite for checks with constraints.
T	getDefaultValue() Returns the default value.
Class<T>	getValueClass() Returns the class of the value.
String	printValue(BehavioralCharacteristics behavioralCharacteristics) Print the given value from the map in BehavioralCharachteristics in a presentable format.
String	toString()

Methods inherited from class org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType

checkCheck, equals, getDescription, getId, hasDefaultValue, hashCode

Methods inherited from class org.opentrafficsim.base.Type

isType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterType

public ParameterType(String id,
                     String description,
                     Class<T> valueClass)

Constructor without default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

ParameterType

public ParameterType(String id,
                     String description,
                     Class<T> valueClass,
                     T defaultValue)

Constructor with default value, without check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

defaultValue - Default value.

ParameterType

public ParameterType(String id,
                     String description,
                     Class<T> valueClass,
                     AbstractParameterType.Check check)

Constructor without default value, with check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

check - Check for parameter values.

ParameterType

public ParameterType(String id,
                     String description,
                     Class<T> valueClass,
                     T defaultValue,
                     AbstractParameterType.Check check)

Constructor with default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

defaultValue - Default value.

check - Check for parameter values.

Method Detail

getValueClass

public final Class<T> getValueClass()

Returns the class of the value.

Returns:

valueClass Class of the value.

check

public void check(T value,
                  BehavioralCharacteristics bc)
           throws ParameterException

Method to overwrite for checks with constraints.

Parameters:

value - Value to check with constraints.

bc - Set of behavioral characteristics.

Throws:

ParameterException - If the value does not comply with constraints.

getDefaultValue

public T getDefaultValue()
                  throws ParameterException

Returns the default value.

Specified by:

getDefaultValue in class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>

Returns:

defaultValue Default value.

Throws:

ParameterException - If no default value was set.

printValue

public final String printValue(BehavioralCharacteristics behavioralCharacteristics)
                        throws ParameterException

Print the given value from the map in BehavioralCharachteristics in a presentable format.

Specified by:

printValue in class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>

Parameters:

behavioralCharacteristics - Behavioral characteristics to get the value from.

Returns:

Printable string of value.

Throws:

ParameterException - If the parameter is not present.

toString

public String toString()

Overrides:

toString in class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>