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

Class InputParameterMap

java.lang.Object

nl.tudelft.simulation.dsol.model.inputparameters.AbstractInputParameter<SortedMap<String,InputParameter<?,?>>,CT>

nl.tudelft.simulation.dsol.model.inputparameters.AbstractInputParameterMap<SortedMap<String,InputParameter<?,?>>>

nl.tudelft.simulation.dsol.model.inputparameters.InputParameterMap

All Implemented Interfaces:

Serializable, Cloneable, InputParameter<SortedMap<String,InputParameter<?,?>>,SortedMap<String,InputParameter<?,?>>>

Direct Known Subclasses:

InputParameterMapDistContinuous, InputParameterMapDistDiscrete

public class InputParameterMap
extends AbstractInputParameterMap<SortedMap<String,InputParameter<?,?>>>

The InputParameterMap contains a number of InputParameters, each of which can also be an InputParameterMap again. The InputParameterMap provides functions to add and remove sub-parameters, to retrieve sub-parameters based on their key, and to return a sorted set of InputParameters based on their displayValue.

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

Nested Class Summary

Nested classes/interfaces inherited from class nl.tudelft.simulation.dsol.model.inputparameters.AbstractInputParameterMap

AbstractInputParameterMap.InputParameterComparator

Constructor Summary

Constructors

Constructor	Description
InputParameterMap(String key, String shortName, String description, double displayPriority)	Construct a new InputParameterMap.

Method Summary

Modifier and Type	Method	Description
InputParameterMap	clone()	Provide the clone() method to make a deep copy.
SortedMap<String,InputParameter<?,?>>	getCalculatedValue()	Retrieve the calculated value of the input parameter.

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

add, get, getSortedSet, printValues, printValues, remove

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

InputParameterMap

public InputParameterMap(String key,
 String shortName,
 String description,
 double displayPriority)

Construct a new InputParameterMap.

Parameters:

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

shortName - String; concise description of the input parameter

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

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

Method Details

getCalculatedValue

public SortedMap<String,InputParameter<?,?>> getCalculatedValue()

Retrieve the calculated value of the input parameter. This is often the same as the value type, except in situations where a sub-map or sub-list calculates a different value. This is, for instance, the case with distribution functions where the parameters are present in a sub-map (the value) and the return type of the value is a distribution function class.

Returns:

CT; the calculated value of the input parameter

clone

public InputParameterMap clone()

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

Specified by:

clone in interface InputParameter<SortedMap<String,InputParameter<?,?>>,SortedMap<String,InputParameter<?,?>>>

Overrides:

clone in class AbstractInputParameterMap<SortedMap<String,InputParameter<?,?>>>

Returns:

a deep copy of the InputParameter