Package nl.tudelft.simulation.dsol.model.inputparameters

Class InputParameterUnit<U extends Unit<U>>

java.lang.Object

nl.tudelft.simulation.dsol.model.inputparameters.AbstractInputParameter<T,T>

nl.tudelft.simulation.dsol.model.inputparameters.InputParameterSelectionMap<String,U>

nl.tudelft.simulation.dsol.model.inputparameters.InputParameterUnit<U>

Type Parameters:

U - the unit type

All Implemented Interfaces:

Serializable, Cloneable, InputParameter<U,U>

public class InputParameterUnit<U extends Unit<U>>
extends InputParameterSelectionMap<String,U>

InputParameterUnit: parameter to select a unit.

Copyright (c) 2003-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl. The source code and binary code of this software is proprietary information of Delft University of Technology.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InputParameterUnit(String key, String shortName, String description, U defaultValue, double displayPriority)	Construct a new InputParameterUnit.

Method Summary

Modifier and Type	Method	Description
InputParameterUnit<U>	clone()	Provide the clone() method to make a deep copy.

Methods inherited from class nl.tudelft.simulation.dsol.model.inputparameters.InputParameterSelectionMap

getCalculatedValue, getKeyforValue, getKeyforValue, getOptions, setKeyforValue, setMapValue, setObjectValue

Methods inherited from class nl.tudelft.simulation.dsol.model.inputparameters.AbstractInputParameter

getDefaultValue, getDescription, getDisplayPriority, getExtendedKey, getKey, getParent, getShortName, getValue, isReadOnly, setDefaultValue, setParent, setReadOnly, setValue, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

InputParameterUnit

public InputParameterUnit(String key,
 String shortName,
 String description,
 U defaultValue,
 double displayPriority)
                   throws InputParameterException

Construct a new InputParameterUnit.

Parameters:

key - String; unique (within the parent's input parameter map) name of the new InputParameterUnit

shortName - String; concise description of the input parameter

description - String; double description of the input parameter (may use HTML markup)

defaultValue - U; the default value of this input parameter

displayPriority - double; sorting order when properties are displayed to the user

Throws:

NullPointerException - when key, shortName, defaultValue, or description is null

IllegalArgumentException - when displayPriority is NaN

InputParameterException - when unit for the default value cannot be found in the unit definition

Method Details

clone

public InputParameterUnit<U> clone()

Provide the clone() method to make a deep copy.

Specified by:

clone in interface InputParameter<U extends Unit<U>,U extends Unit<U>>

Overrides:

clone in class InputParameterSelectionMap<String,U extends Unit<U>>

Returns:

a deep copy of the InputParameter