Package microsim.statistics.functions

Class MaxTraceFunction.Long

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.MaxTraceFunction

microsim.statistics.functions.MaxTraceFunction.Long

All Implemented Interfaces:

EventListener, IDoubleSource, ILongSource, IUpdatableSource

Enclosing class:

MaxTraceFunction

public static class MaxTraceFunction.Long
extends MaxTraceFunction
implements ILongSource

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

Author:

Michele Sonnessa

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

ILongSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected long	max
protected ILongSource	target

Fields inherited from class microsim.statistics.functions.MaxTraceFunction

count

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

Constructor Summary

Constructors

Constructor	Description
Long(Object source, String valueName, boolean getFromMethod)	Create a basic statistic probe on a generic object.
Long(ILongSource 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.
long	getLastValue()	Return the last double value read from the source object.
long	getLongValue(Enum<?> valueID)	Return the result of a given statistic.
long	getMax()	The current maximum 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 long max

target

protected ILongSource target

Constructor Details

Long

public Long(ILongSource source,
 Enum<?> valueID)

Create a basic statistic probe on a IDblSource object.

Parameters:

source - The ILongSource object.

valueID - The value identifier defined by source object.

Long

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

getLongValue

public long getLongValue(Enum<?> valueID)

Return the result of a given statistic.

Specified by:

getLongValue in interface ILongSource

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

Return the last double value read from the source object.

Returns:

A double value collected at the last reading operation.

getMax

public long getMax()

The current maximum value.

Returns:

The maximum value.