Package microsim.statistics.functions

Class MultiTraceFunction.Double

java.lang.Object

microsim.statistics.functions.MultiTraceFunction

microsim.statistics.functions.MultiTraceFunction.Double

All Implemented Interfaces:

EventListener, DoubleSource, UpdatableSource

Enclosing class:

MultiTraceFunction

public static class MultiTraceFunction.Double
extends MultiTraceFunction
implements DoubleSource

An implementation of the Memoryless Series class, which manages double type data sources.

Nested Class Summary

Nested classes/interfaces inherited from class microsim.statistics.functions.MultiTraceFunction

MultiTraceFunction.Double, MultiTraceFunction.Integer, MultiTraceFunction.Long, MultiTraceFunction.Variables

Nested classes/interfaces inherited from interface microsim.statistics.DoubleSource

DoubleSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected double	max
protected double	min
protected double	sum
protected double	sumSquare
protected DoubleSource	target

Fields inherited from class microsim.statistics.functions.MultiTraceFunction

count

Constructor Summary

Constructors

Constructor	Description
Double(@NonNull Object source, @NonNull String valueName, boolean getFromMethod)	Creates a basic statistic probe on a generic object.
Double(@NonNull DoubleSource source, @NonNull Enum<?> valueID)	Creates a basic statistic probe on a DoubleSource object.

Method Summary

Modifier and Type	Method	Description
double	getDoubleValue(@NonNull Enum<?> valueID)	Returns the result of a given statistic.
double	getMean()	The mean function.
double	getVariance()	The variance function.
void	updateSource()	Reads the source values and update statistics.

Methods inherited from class microsim.statistics.functions.MultiTraceFunction

getCount, onEvent

Methods inherited from class java.lang.Object

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

Field Details

max

protected double max

min

protected double min

sum

protected double sum

sumSquare

protected double sumSquare

target

protected DoubleSource target

Constructor Details

Double

public Double(@NonNull
 @NonNull DoubleSource source,
 @NonNull
 @NonNull Enum<?> valueID)

Creates a basic statistic probe on a DoubleSource object.

Parameters:

source - The DoubleSource object.

valueID - The value identifier defined by source object.

Throws:

NullPointerException - when any of the input parameters is null.

Double

public Double(@NonNull
 @NonNull Object source,
 @NonNull
 @NonNull String valueName,
 boolean getFromMethod)

Creates a basic statistic probe on a generic object.

Parameters:

source - A generic source object.

valueName - The name of the field or the method returning the variable to be probed.

getFromMethod - Specifies if valueName is a method or a property value.

Throws:

NullPointerException - when any of the input parameters is null.

Method Details

updateSource

public void updateSource()

Reads the source values and update statistics.

Specified by:

updateSource in interface UpdatableSource

Overrides:

updateSource in class MultiTraceFunction

getDoubleValue

public double getDoubleValue(@NonNull
 @NonNull Enum<?> valueID)

Returns the result of a given statistic.

Specified by:

getDoubleValue in interface DoubleSource

Overrides:

getDoubleValue in class MultiTraceFunction

Parameters:

valueID - One of the MultiTraceFunction.Variables constants representing available statistics.

Returns:

The computed value.

Throws:

NullPointerException - when any of the input parameters is null.

getVariance

public double getVariance()

The variance function.

Specified by:

getVariance in class MultiTraceFunction

Returns:

The variance value.

getMean

public double getMean()

The mean function.

Specified by:

getMean in class MultiTraceFunction

Returns:

The mean value.