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, DoubleSource, UpdatableSource

Enclosing class:

MaxTraceFunction

public static class MaxTraceFunction.Double
extends MaxTraceFunction
implements DoubleSource

An implementation of the Memoryless Series class, which manages double 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.DoubleSource

DoubleSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected double	max
protected DoubleSource	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(@NonNull Object source, @NonNull String valueName, boolean getFromMethod)	Creates a basic statistic probe on a generic object.
Double(@NonNull DoubleSource source, @NonNull Enum<?> valueID)	Creates a basic statistic probe on a DoubleSource 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.

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 DoubleSource target

Constructor Details

Double

public Double(@NonNull
 @NonNull DoubleSource source,
 @NonNull
 @NonNull Enum<?> valueID)

Creates a basic statistic probe on a DoubleSource object.

Parameters:

source - The DoubleSource object.

valueID - The value identifier defined by source object.

Throws:

NullPointerException - when any of the input parameters is null.

Double

public Double(@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 any of the input parameters is null.