org.opentrafficsim.core.gtu.drivercharacteristics

Class ParameterTypeDouble

java.lang.Object

org.opentrafficsim.core.gtu.drivercharacteristics.AbstractParameterType<org.djunits.value.vdouble.scalar.Dimensionless>

org.opentrafficsim.core.gtu.drivercharacteristics.ParameterTypeDouble

public class ParameterTypeDouble
extends AbstractParameterType<org.djunits.value.vdouble.scalar.Dimensionless>

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
ParameterTypeDouble(String id, String description) Constructor without default value.
ParameterTypeDouble(String id, String description, double defaultValue) Constructor with default value.

Method Summary

Modifier and Type	Method and Description
void	check(double value) Method to overwrite for checks with constraints.
void	check(double value, BehavioralCharacteristics bc) Method to overwrite for checks with constraints.

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

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           double defaultValue)

Constructor with default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

defaultValue - Default value.

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description)

Constructor without default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

Method Detail

check

public void check(double 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

public void check(double 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.