Package microsim.statistics.functions

Class MultiTraceFunction.Float

java.lang.Object

microsim.statistics.functions.MultiTraceFunction

microsim.statistics.functions.MultiTraceFunction.Float

All Implemented Interfaces:

EventListener, IDoubleSource, IFloatSource, IUpdatableSource

Enclosing class:

MultiTraceFunction

public static class MultiTraceFunction.Float
extends MultiTraceFunction
implements IFloatSource

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

IFloatSource.Variables

Field Summary

Fields

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

Fields inherited from class microsim.statistics.functions.MultiTraceFunction

count

Constructor Summary

Constructors

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

min

protected float min

sum

protected float sum

sumSquare

protected double sumSquare

target

protected IFloatSource target

Constructor Details

Float

public Float(IFloatSource 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.

Float

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

getFloatValue

public float getFloatValue(Enum<?> valueID)

Return the result of a given statistic.

Specified by:

getFloatValue in interface IFloatSource

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

Return the last float value read from the source object.

Returns:

A float value collected at the last reading operation.

getMax

public float getMax()

The maximum function.

Returns:

The maximum value.

getSum

public float getSum()

The sum function.

Returns:

The sum of collected values.

getMin

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