Package microsim.statistics.functions

Class MinTraceFunction.Float

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.MinTraceFunction

microsim.statistics.functions.MinTraceFunction.Float

All Implemented Interfaces:

EventListener, IDoubleSource, IFloatSource, IUpdatableSource

Enclosing class:

MinTraceFunction

public static class MinTraceFunction.Float
extends MinTraceFunction
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.MinTraceFunction

MinTraceFunction.Double, MinTraceFunction.Float, MinTraceFunction.Integer, MinTraceFunction.Long, MinTraceFunction.Variables

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

IFloatSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected float	min
protected IFloatSource	target

Fields inherited from class microsim.statistics.functions.MinTraceFunction

count

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

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
void	applyFunction()	Read the source values and update statistics.
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 double value read from the source object.
float	getMin()	The minimum function.

Methods inherited from class microsim.statistics.functions.MinTraceFunction

onEvent

Methods inherited from class microsim.statistics.functions.AbstractFunction

isCheckingTime, setCheckingTime, updateSource

Methods inherited from class java.lang.Object

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

Field Details

min

protected float min

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

applyFunction

public void applyFunction()

Read the source values and update statistics.

Overrides:

applyFunction in class MinTraceFunction

getDoubleValue

public double getDoubleValue(Enum<?> valueID)

Return the result of a given statistic.

Specified by:

getDoubleValue in interface IDoubleSource

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.

getLastValue

public float getLastValue()

Return the last double value read from the source object.

Returns:

A double value collected at the last reading operation.

getMin

public float getMin()

The minimum function.

Returns:

The minimum value.