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

Class InputParameterDistContinuousSelection

java.lang.Object

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

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

nl.tudelft.simulation.dsol.model.inputparameters.InputParameterDistContinuousSelection

All Implemented Interfaces:

Serializable, Cloneable, InputParameter<InputParameterMapDistContinuous,InputParameterMapDistContinuous>

public class InputParameterDistContinuousSelection
extends InputParameterSelectionMap<String,InputParameterMapDistContinuous>

InputParameterDistContinuousSelection takes care of exposing the necessary parameters for each of the continuous distribution functions. It has a function called getDist() which returns the distribution of the current choice.

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

Modifier and Type	Class	Description
static class	InputParameterDistContinuousSelection.Beta	InputParameterDistContinuous.Beta class.
static class	InputParameterDistContinuousSelection.Constant	InputParameterDistContinuous.Constant class.
static class	InputParameterDistContinuousSelection.Erlang	InputParameterDistContinuous.Erlang class.
static class	InputParameterDistContinuousSelection.Exponential	InputParameterDistContinuous.Exponential class.
static class	InputParameterDistContinuousSelection.Gamma	InputParameterDistContinuous.Gamma class.
static class	InputParameterDistContinuousSelection.LogNormal	InputParameterDistContinuous.LogNormal class.
static class	InputParameterDistContinuousSelection.Normal	InputParameterDistContinuous.Normal class.
static class	InputParameterDistContinuousSelection.Pearson5	InputParameterDistContinuous.Pearson5 class.
static class	InputParameterDistContinuousSelection.Pearson6	InputParameterDistContinuous.Pearson6 class.
static class	InputParameterDistContinuousSelection.Triangular	InputParameterDistContinuous.Triangular class.
static class	InputParameterDistContinuousSelection.Uniform	InputParameterDistContinuous.Uniform class.
static class	InputParameterDistContinuousSelection.Weibull	InputParameterDistContinuous.Weibull class.

Constructor Summary

Constructors

Constructor	Description
InputParameterDistContinuousSelection(String key, String shortName, String description, StreamInterface stream, double displayPriority)

Method Summary

Modifier and Type	Method	Description
DistContinuous	getDist()	Return the distribution function corresponding to the chosen distribution and parameters.
static final SortedMap<String,InputParameterMapDistContinuous>	getDistOptions()
StreamInterface	getStream()

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

clone, 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

InputParameterDistContinuousSelection

public InputParameterDistContinuousSelection(String key,
 String shortName,
 String description,
 StreamInterface stream,
 double displayPriority)
                                      throws InputParameterException

Parameters:

key - String; unique name for the selection parameter of the distribution function

shortName - String; concise description of the input parameter

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

stream - StreamInterface; the random number stream to use for the distribution

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

Throws:

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

IllegalArgumentException - when displayPriority is NaN

InputParameterException - in case the default value is not part of the list; should not happen

Method Details

getDist

public DistContinuous getDist()
                       throws InputParameterException

Return the distribution function corresponding to the chosen distribution and parameters.

Returns:

DistContinuous; the distribution function corresponding to the chosen distribution and parameters

Throws:

InputParameterException - on error retrieving the values for the distribution

getDistOptions

public static final SortedMap<String,InputParameterMapDistContinuous> getDistOptions()

Returns:

distOptions

getStream

public StreamInterface getStream()

Returns:

stream