Package microsim.statistics.functions

Class MaxTraceFunction.Double

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.MaxTraceFunction

microsim.statistics.functions.MaxTraceFunction.Double

All Implemented Interfaces:

EventListener, IDoubleSource, IUpdatableSource

Enclosing class:

MaxTraceFunction

public static class MaxTraceFunction.Double
extends MaxTraceFunction
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.MaxTraceFunction

MaxTraceFunction.Double, MaxTraceFunction.Float, MaxTraceFunction.Integer, MaxTraceFunction.Long, MaxTraceFunction.Variables

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

IDoubleSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected double	max
protected IDoubleSource	target

Fields inherited from class microsim.statistics.functions.MaxTraceFunction

count

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

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
void	applyFunction()	Read the source values and update statistics.
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()	Return the current max value.

Methods inherited from class microsim.statistics.functions.MaxTraceFunction

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

max

protected double max

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

applyFunction

public void applyFunction()

Read the source values and update statistics.

Overrides:

applyFunction in class MaxTraceFunction

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.

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

Return the current max value.

Returns:

The maximum value.