Package microsim.statistics.functions

Class MultiTraceFunction.Integer

java.lang.Object

microsim.statistics.functions.MultiTraceFunction

microsim.statistics.functions.MultiTraceFunction.Integer

All Implemented Interfaces:

EventListener, IDoubleSource, IIntSource, IUpdatableSource

Enclosing class:

MultiTraceFunction

public static class MultiTraceFunction.Integer
extends MultiTraceFunction
implements IIntSource

An implementation of the MemorylessSeries class, which manages integer 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.IIntSource

IIntSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected int	max
protected int	min
protected int	sum
protected long	sumSquare
protected IIntSource	target

Fields inherited from class microsim.statistics.functions.MultiTraceFunction

count

Constructor Summary

Constructors

Constructor	Description
Integer(Object source, String valueName, boolean getFromMethod)	Create a basic statistic probe on a generic object.
Integer(IIntSource 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.
int	getIntValue(Enum<?> valueID)	Return the result of a given statistic.
int	getLastValue()	Return the last int value read from the source object.
int	getMax()	The maximum function.
double	getMean()	The mean function.
int	getMin()	The minimum function.
int	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 int max

min

protected int min

sum

protected int sum

sumSquare

protected long sumSquare

target

protected IIntSource target

Constructor Details

Integer

public Integer(IIntSource 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.

Integer

public Integer(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.

getIntValue

public int getIntValue(Enum<?> valueID)

Return the result of a given statistic.

Specified by:

getIntValue in interface IIntSource

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 int getLastValue()

Return the last int value read from the source object.

Returns:

A int value collected at the last reading operation.

getMax

public int getMax()

The maximum function.

Returns:

The maximum value.

getSum

public int getSum()

The sum function.

Returns:

The sum of collected values.

getMin

public int 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.