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

Class InputParameterMapDistDiscrete

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

nl.tudelft.simulation.dsol.model.inputparameters.InputParameterMapDistDiscrete

All Implemented Interfaces:

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

Direct Known Subclasses:

InputParameterDistDiscreteSelection.Bernoulli, InputParameterDistDiscreteSelection.Binomial, InputParameterDistDiscreteSelection.DiscreteConstant, InputParameterDistDiscreteSelection.DiscreteUniform, InputParameterDistDiscreteSelection.Geometric, InputParameterDistDiscreteSelection.NegBinomial, InputParameterDistDiscreteSelection.Poisson

public abstract class InputParameterMapDistDiscrete
extends InputParameterMap

InputParameterMapDistDiscrete is a InputParameterMap with a stream, a getDist() and a setDist() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected DistDiscrete	dist	the distribution based on the input.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
InputParameterMapDistDiscrete	clone()	Provide the clone() method to make a deep copy.
DistDiscrete	getDist()	Return the previously calculated typed value based on the components.
StreamInterface	getStream()
abstract void	setDist()	Calculate the distribution for this parameter entry.
void	setStream(StreamInterface stream)

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

getCalculatedValue

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

Field Details

dist

protected DistDiscrete dist

the distribution based on the input.

Constructor Details

InputParameterMapDistDiscrete

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

setDist

public abstract void setDist()
                      throws InputParameterException

Calculate the distribution for this parameter entry.

Throws:

InputParameterException - when the distribution based on the parameter map cannot be constructed

getDist

public DistDiscrete getDist()
                     throws InputParameterException

Return the previously calculated typed value based on the components.

Returns:

T; the previously calculated typed value based on the components

Throws:

InputParameterException - when the value has not been calculated

getStream

public StreamInterface getStream()

Returns:

stream

setStream

public void setStream(StreamInterface stream)

Parameters:

stream - StreamInterface; set stream

clone

public InputParameterMapDistDiscrete 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 InputParameterMap

Returns:

a deep copy of the InputParameter