Package microsim.statistics.functions

Class MaxTraceFunction.Integer

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.MaxTraceFunction

microsim.statistics.functions.MaxTraceFunction.Integer

All Implemented Interfaces:

EventListener, DoubleSource, IntSource, UpdatableSource

Enclosing class:

MaxTraceFunction

public static class MaxTraceFunction.Integer
extends MaxTraceFunction
implements IntSource

An implementation of the Memoryless Series class, which manages integer type data sources.

Nested Class Summary

Nested classes/interfaces inherited from class microsim.statistics.functions.MaxTraceFunction

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

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

IntSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected int	max
protected IntSource	target

Fields inherited from class microsim.statistics.functions.MaxTraceFunction

count

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

Constructor Summary

Constructors

Constructor	Description
Integer(@NonNull Object source, @NonNull String valueName, boolean getFromMethod)	Creates a basic statistic probe on a generic object.
Integer(@NonNull IntSource source, @NonNull Enum<?> valueID)	Creates a basic statistic probe on a IntSource object.

Method Summary

Modifier and Type	Method	Description
void	applyFunction()	Reads the source values and update statistics.
double	getDoubleValue(@NonNull Enum<?> valueID)	Returns the result of a given statistic.
int	getIntValue(@NonNull Enum<?> valueID)	Returns the integer value corresponding to the given variableID

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 int max

target

protected IntSource target

Constructor Details

Integer

public Integer(@NonNull
 @NonNull IntSource source,
 @NonNull
 @NonNull Enum<?> valueID)

Creates a basic statistic probe on a IntSource object.

Parameters:

source - The IntSource object.

valueID - The value identifier defined by source object.

Throws:

NullPointerException - when any of the input parameters is null.

Integer

public Integer(@NonNull
 @NonNull Object source,
 @NonNull
 @NonNull String valueName,
 boolean getFromMethod)

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

Throws:

NullPointerException - when any of the input parameters is null.

Method Details

applyFunction

public void applyFunction()

Reads the source values and update statistics.

Overrides:

applyFunction in class MaxTraceFunction

getDoubleValue

public double getDoubleValue(@NonNull
 @NonNull Enum<?> valueID)

Returns the result of a given statistic.

Specified by:

getDoubleValue in interface DoubleSource

Parameters:

valueID - One of the MaxTraceFunction.Variables constants representing available statistics.

Returns:

The computed value.

Throws:

NullPointerException - when valueID is null.

getIntValue

public int getIntValue(@NonNull
 @NonNull Enum<?> valueID)

Description copied from interface: IntSource

Returns the integer value corresponding to the given variableID

Specified by:

getIntValue in interface IntSource

Parameters:

valueID - A unique identifier for a variable.

Returns:

The current integer value of the required variable.