Package microsim.statistics.functions

Class MultiTraceFunction.Double

java.lang.Object

microsim.statistics.functions.MultiTraceFunction

microsim.statistics.functions.MultiTraceFunction.Double

All Implemented Interfaces:

EventListener, IDoubleSource, IUpdatableSource

Enclosing class:

MultiTraceFunction

public static class MultiTraceFunction.Double
extends MultiTraceFunction
implements IDoubleSource

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

Author:

Michele Sonnessa and Ross Richardson

Nested Class Summary

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

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

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

IDoubleSource.Variables

Field Summary

Fields

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

Fields inherited from class microsim.statistics.functions.MultiTraceFunction

count

Constructor Summary

Constructors

Constructor	Description
Double(Object source, String valueName, boolean getFromMethod)	Create a basic statistic probe on a generic object.
Double(IDoubleSource source, Enum<?> valueID)	Create a basic statistic probe on a IDblSource object.

Method Summary

Modifier and Type	Method	Description
double	getDoubleValue(Enum<?> valueID)	Return the result of a given statistic.
double	getLastValue()	Return the last double value read from the source object.
double	getMax()	The maximum function.
double	getMean()	The mean function.
double	getMin()	The minimum function.
double	getSum()	The sum function.
double	getVariance()	The variance function.
void	updateSource()	Read 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 IDoubleSource target

Constructor Details

Double

public Double(IDoubleSource source,
 Enum<?> valueID)

Create a basic statistic probe on a IDblSource object.

Parameters:

source - The IDblSource object.

valueID - The value identifier defined by source object.

Double

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

Create 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.

Method Details

updateSource

public void updateSource()

Read the source values and update statistics.

Specified by:

updateSource in interface IUpdatableSource

Overrides:

updateSource in class MultiTraceFunction

getDoubleValue

public double getDoubleValue(Enum<?> valueID)

Return the result of a given statistic.

Specified by:

getDoubleValue in interface IDoubleSource

Overrides:

getDoubleValue in class MultiTraceFunction

Parameters:

valueID - One of the F_ constants representing available statistics.

Returns:

The computed value.

Throws:

UnsupportedOperationException - If the given valueID is not supported.

getVariance

public double getVariance()

The variance function.

Specified by:

getVariance in class MultiTraceFunction

Returns:

The variance value.

getLastValue

public double getLastValue()

Return the last double value read from the source object.

Returns:

A double value collected at the last reading operation.

getMax

public double getMax()

The maximum function.

Returns:

The maximum value.

getSum

public double getSum()

The sum function.

Returns:

The sum of collected values.

getMin

public double getMin()

The minimum function.

Returns:

The minimum value.

getMean

public double getMean()

The mean function.

Specified by:

getMean in class MultiTraceFunction

Returns:

The mean value.