org.opentrafficsim.core.gtu.behavioralcharacteristics

Class ParameterTypeBoolean

java.lang.Object

org.opentrafficsim.core.Type<AbstractParameterType<?,?>>

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

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterTypeBoolean

All Implemented Interfaces:

Serializable

public class ParameterTypeBoolean
extends AbstractParameterType<org.djunits.unit.DimensionlessUnit,org.djunits.value.vdouble.scalar.Dimensionless>
implements Serializable

Wrapper class for boolean 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
ParameterTypeBoolean(String id, String description) Constructor without default value.
ParameterTypeBoolean(String id, String description, boolean defaultValue) Constructor with default value.
ParameterTypeBoolean(String id, String description, boolean defaultValue, boolean hasDefaultValue) Private constructor with default value, which may check the default value.

Method Summary

Modifier and Type	Method and Description
Boolean	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.core.Type

isType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterTypeBoolean

public ParameterTypeBoolean(String id,
                            String description)

Constructor without default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

ParameterTypeBoolean

public ParameterTypeBoolean(String id,
                            String description,
                            boolean defaultValue)

Constructor with default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

defaultValue - Default value.

ParameterTypeBoolean

public ParameterTypeBoolean(String id,
                            String description,
                            boolean defaultValue,
                            boolean hasDefaultValue)

Private constructor with default value, which may check the default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

defaultValue - Default value.

hasDefaultValue - Whether to check the default value for null.

Method Detail

getDefaultValue

public final Boolean getDefaultValue()
                              throws ParameterException

Returns the default value.

Specified by:

getDefaultValue in class AbstractParameterType<org.djunits.unit.DimensionlessUnit,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.unit.DimensionlessUnit,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.

toString

public String toString()

Overrides:

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