org.opentrafficsim.core.gtu.behavioralcharacteristics

Class ParameterTypeDouble

java.lang.Object

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

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

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterTypeDouble

All Implemented Interfaces:

Serializable

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

Wrapper class for double parameters.

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

Method Summary

Modifier and Type	Method and Description
void	check(double value, BehavioralCharacteristics bc) Method to overwrite for checks with constraints.
Double	getDefaultValue() Returns the default 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

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description)

Constructor without default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

ParameterTypeDouble

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

Constructor with default value, without check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name..

defaultValue - Default value.

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           AbstractParameterType.Check check)

Constructor without default value, with check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

check - Check for parameter values.

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           double defaultValue,
                           AbstractParameterType.Check check)

Constructor with default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

defaultValue - Default value.

check - Check for parameter values.

Method Detail

getDefaultValue

public final Double getDefaultValue()
                             throws ParameterException

Returns the default value.

Specified by:

getDefaultValue in class AbstractParameterType<org.djunits.value.vdouble.scalar.Dimensionless>

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<org.djunits.value.vdouble.scalar.Dimensionless>

Parameters:

behavioralCharacteristics - Behavioral characteristics to get the value from.

Returns:

Printable string of value.

Throws:

ParameterException - If the parameter is not present.

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.

toString

public String toString()

Overrides:

toString in class AbstractParameterType<org.djunits.value.vdouble.scalar.Dimensionless>