org.opentrafficsim.core.gtu.drivercharacteristics

Class ParameterTypePositive<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>

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

Type Parameters:

T - The parameter type

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

Extends ParameterType with a default check for a positive and non-zero value.

Author:

Wouter Schakel

Field Summary

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

valueClass

Constructor Summary

Constructors

Constructor and Description
ParameterTypePositive(String id, String description, Class<T> valueClass) Constructor without default value.
ParameterTypePositive(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) Check if value is positive and non-zero.
protected void	check(T value, BehavioralCharacteristics bc) Check if value is positive and non-zero.

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

getValueClass

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

ParameterTypePositive

public ParameterTypePositive(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.

ParameterTypePositive

public ParameterTypePositive(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

check

protected void check(T value)
              throws ParameterException

Check if value is positive and non-zero.

Overrides:

check in class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>

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

Check if value is positive and non-zero.

Overrides:

check in class ParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>

Parameters:

value - Value to check with constraints.

bc - Set of behavioral characteristics.

Throws:

ParameterException - If the value does not comply with constraints.