org.opentrafficsim.base.parameters

Class ParameterTypeFrequency

java.lang.Object

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

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

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

org.opentrafficsim.base.parameters.ParameterTypeFrequency

All Implemented Interfaces:

Serializable, Identifiable

public class ParameterTypeFrequency
extends ParameterTypeNumeric<Frequency>
implements Serializable

Wrapper class for Frequency parameters.

Copyright (c) 2013-2019 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 and Description
ParameterTypeFrequency(String id, String description) Construct a new ParameterTypeFrequency without default value and check.
ParameterTypeFrequency(String id, String description, Constraint<? super Frequency> constraint) Construct a new ParameterTypeFrequency without default value, with check.
ParameterTypeFrequency(String id, String description, Frequency defaultValue) Construct a new ParameterTypeFrequency with default value, without check.
ParameterTypeFrequency(String id, String description, Frequency defaultValue, Constraint<? super Frequency> constraint) Construct a new ParameterTypeFrequency with default value and check.

Method Summary

Modifier and Type	Method and Description
String	toString()

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

printValue

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

ParameterTypeFrequency

public ParameterTypeFrequency(String id,
                              String description)

Construct a new ParameterTypeFrequency without default value and check.

Parameters:

id - String; short name of the new ParameterTypeFrequency

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

ParameterTypeFrequency

public ParameterTypeFrequency(String id,
                              String description,
                              Frequency defaultValue)

Construct a new ParameterTypeFrequency with default value, without check.

Parameters:

id - String; short name of the new ParameterTypeFrequency

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

defaultValue - Frequency; the default value of the new ParameterTypeFrequency

ParameterTypeFrequency

public ParameterTypeFrequency(String id,
                              String description,
                              Constraint<? super Frequency> constraint)

Construct a new ParameterTypeFrequency without default value, with check.

Parameters:

id - String; short name of the new ParameterTypeFrequency

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

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

ParameterTypeFrequency

public ParameterTypeFrequency(String id,
                              String description,
                              Frequency defaultValue,
                              Constraint<? super Frequency> constraint)

Construct a new ParameterTypeFrequency with default value and check.

Parameters:

id - String; short name of the new ParameterTypeFrequency

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

defaultValue - Frequency; the default value of the new ParameterTypeFrequency

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

Method Detail

toString

public final String toString()

Overrides:

toString in class ParameterTypeNumeric<Frequency>