org.opentrafficsim.core.gtu.drivercharacteristics

Class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>

java.lang.Object

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

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

Type Parameters:

T - Class of the value.

Direct Known Subclasses:

ParameterTypePositive

public class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>
extends AbstractParameterType<T>

Defines meta-information of a parameter, defining the parameter uniquely.

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

Field Summary

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

valueClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	check(T value) Method to overwrite for checks with constraints.
protected void	check(T value, BehavioralCharacteristics bc) Method to overwrite for checks with constraints.
Class<T>	getValueClass() Returns the class of the value.

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

equals, getDefaultValue, getDescription, getId, hashCode, toString

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,
                     T defaultValue)

Constructor with default value.

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)

Constructor without default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

Method Detail

getValueClass

public final Class<T> getValueClass()

Returns the class of the value.

Returns:

valueClass Class of the value.

check

protected void check(T value)
              throws ParameterException

Method to overwrite for checks with constraints.

Parameters:

value - Value to check with constraints.

Throws:

ParameterException - If the value does not comply with constraints.

check

protected 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.