Package org.opentrafficsim.base.parameters

Class ParameterTypeDouble

java.lang.Object

org.opentrafficsim.base.Type<ParameterType<T>>

org.opentrafficsim.base.parameters.ParameterType<T>

org.opentrafficsim.base.parameters.ParameterTypeNumeric<Double>

org.opentrafficsim.base.parameters.ParameterTypeDouble

All Implemented Interfaces:

Serializable, Identifiable

public class ParameterTypeDouble
extends ParameterTypeNumeric<Double>
implements Serializable

Wrapper class for double parameters.

Copyright (c) 2013-2020 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

Field Summary

Fields inherited from class org.opentrafficsim.base.parameters.ParameterType

defaultValue

Constructor Summary

Constructors

Constructor	Description
ParameterTypeDouble(String id, String description)	Construct a new ParameterTypeDouble without default value and check.
ParameterTypeDouble(String id, String description, double defaultValue)	Construct a new ParameterTypeDouble with default value, without check.
ParameterTypeDouble(String id, String description, double defaultValue, Constraint<? super Double> constraint)	Construct a new ParameterTypeDouble with default value and check.
ParameterTypeDouble(String id, String description, Double defaultValue, Constraint<Number> constraint)	Construct a new ParameterTypeDouble with default value and check.
ParameterTypeDouble(String id, String description, Constraint<? super Double> constraint)	Construct a new ParameterTypeDouble without default value, with check.

Method Summary

Modifier and Type	Method	Description
String	printValue(Parameters parameters)	Print the given value from the map in Parameters in a presentable format.
String	toString()

Methods inherited from class org.opentrafficsim.base.parameters.ParameterType

check, checkConstraint, equals, getConstraint, getDefaultValue, getDescription, getId, getValueClass, 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)

Construct a new ParameterTypeDouble without default value and check.

Parameters:

id - String; short name of the new ParameterTypeDouble

description - String; parameter description or full name of the new ParameterTypeDouble

ParameterTypeDouble

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

Construct a new ParameterTypeDouble with default value, without check.

Parameters:

id - String; short name of the new ParameterTypeDouble

description - String; parameter description or full name of the new ParameterTypeDouble

defaultValue - double; the default value of the new ParametertypeDouble

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           Constraint<? super Double> constraint)

Construct a new ParameterTypeDouble without default value, with check.

Parameters:

id - String; short name of the new ParameterTypeDouble

description - String; parameter description or full name of the new ParameterTypeDouble

constraint - Constrain<? super Double>; constraint for parameter values

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           double defaultValue,
                           Constraint<? super Double> constraint)

Construct a new ParameterTypeDouble with default value and check.

Parameters:

id - String; short name of the new ParameterTypeDouble

description - String; parameter description or full name of the new ParameterTypeDouble

defaultValue - double; the default value of the new ParameterTypeDouble

constraint - Constraint<? super Double>; constraint for parameter values

ParameterTypeDouble

public ParameterTypeDouble(String id,
                           String description,
                           Double defaultValue,
                           Constraint<Number> constraint)

Construct a new ParameterTypeDouble with default value and check.

Parameters:

id - String; short name of the new ParameterTypeDouble

description - String; parameter description or full name of the new ParameterTypeDouble

defaultValue - Double; default value for the new ParameterTypeDouble

constraint - Constraint<Number>; constraint for parameter values

Method Detail

printValue

public final String printValue(Parameters parameters)
                        throws ParameterException

Print the given value from the map in Parameters in a presentable format. The default implementation simply returns the output of toString().

Overrides:

printValue in class ParameterTypeNumeric<Double>

Parameters:

parameters - Parameters; Parameters to get the value from

Returns:

String; readable representation of the value

Throws:

ParameterException - If the parameter is not present

toString

public String toString()

Overrides:

toString in class ParameterTypeNumeric<Double>