Package microsim.data

Class ParameterRangeDomain

java.lang.Object

microsim.data.ParameterDomain

microsim.data.ParameterRangeDomain

public class ParameterRangeDomain
extends ParameterDomain

This class is an extension of ParameterDomain where values that are stored are elements of arithmetic progressions of floating-point numbers generated from intervals.

Constructor Summary

Constructors

Constructor	Description
ParameterRangeDomain()	The default constructor, creates an instance only.
ParameterRangeDomain(@NonNull String name, @NonNull Double min, @NonNull Double max, @NonNull Double step)	Creates an instance of the class, sets the name and min, max, and step values.

Method Summary

Modifier and Type	Method	Description
@NonNull Object[]	getValues()	Generates the actual arithmetic progression and returns all the values.
void	setValues(Object[] values)	This method is not supported.

Methods inherited from class microsim.data.ParameterDomain

addValue

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterRangeDomain

public ParameterRangeDomain()

The default constructor, creates an instance only.

ParameterRangeDomain

public ParameterRangeDomain(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Double min,
 @NonNull
 @NonNull Double max,
 @NonNull
 @NonNull Double step)

Creates an instance of the class, sets the name and min, max, and step values.

Parameters:

name - The range name.

min - The left bound of the interval.

max - The right bound of the interval.

step - The step of the progression.

Throws:

NullPointerException - when any of the input parameters is null.

Method Details

getValues

@NonNull
public @NonNull Object[] getValues()

Generates the actual arithmetic progression and returns all the values.

Returns:

an array of objects that are instances of Double, always not null.

Implementation Note:

The left bound is always included, but the right one might or might not be. That depends on the actual parameters of the progression, various numerical errors also affect the result.

setValues

public void setValues(Object[] values)

This method is not supported.

Throws:

UnsupportedOperationException - when executed.