org.opentrafficsim.core.gtu.drivercharacteristics

Class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>

java.lang.Object

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

Type Parameters:

T - Class of the value.

Direct Known Subclasses:

ParameterType, ParameterTypeBoolean, ParameterTypeDouble, ParameterTypeInteger

public abstract class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>>
extends Object

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

Modifier and Type	Field and Description
protected Class<T>	valueClass Class of the value.

Constructor Summary

Constructors

Constructor and Description
AbstractParameterType(String id, String description, Class<T> valueClass) Constructor without default value.
AbstractParameterType(String id, String description, Class<T> valueClass, T defaultValue) Constructor with default value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	getDefaultValue() Returns the default value.
String	getDescription() Returns the parameter description.
String	getId() Returns the parameter id.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

valueClass

protected final Class<T extends org.djunits.value.vdouble.scalar.DoubleScalar.Rel<?>> valueClass

Class of the value.

Constructor Detail

AbstractParameterType

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

AbstractParameterType

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

getId

public final String getId()

Returns the parameter id.

Returns:

id Parameter id.

getDescription

public final String getDescription()

Returns the parameter description.

Returns:

description

getDefaultValue

public final T getDefaultValue()
                        throws ParameterException

Returns the default value.

Returns:

defaultValue Default value.

Throws:

ParameterException - If no default value was set.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object