Package microsim.statistics.functions

Class MovingAverageTraceFunction

java.lang.Object

microsim.statistics.functions.AbstractFunction

microsim.statistics.functions.MovingAverageTraceFunction

All Implemented Interfaces:

EventListener, DoubleSource, UpdatableSource

public class MovingAverageTraceFunction
extends AbstractFunction
implements DoubleSource

This class computes the average of the last values collected from a data source. The number of values used to compute the average value is specified in the constructor. The mean function return always double values, so it implements only the DoubleSource interface.

Nested Class Summary

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

DoubleSource.Variables

Field Summary

Fields

Modifier and Type	Field	Description
protected double	average
protected DoubleSource	dblSource
protected IntSource	intSource
protected int	len
protected LongSource	lngSource
protected int	type
protected static final int	TYPE_DBL
protected static final int	TYPE_INT
protected static final int	TYPE_LNG
protected int	valueCount
protected Enum<?>	valueID
protected double[]	values

Fields inherited from class microsim.statistics.functions.AbstractFunction

timeChecker

Constructor Summary

Constructors

Constructor	Description
MovingAverageTraceFunction(@NonNull DoubleSource source, @NonNull Enum<?> valueID, int windowSize)	Creates a basic statistic probe on a DoubleSource object.
MovingAverageTraceFunction(@NonNull IntSource source, @NonNull Enum<?> valueID, int windowSize)	Create a basic statistic probe on a IntSource object.
MovingAverageTraceFunction(@NonNull LongSource source, @NonNull Enum<?> valueID, int windowSize)	Creates a basic statistic probe on a LongSource object.

Method Summary

Modifier and Type	Method	Description
void	applyFunction()	Collects a value from the source.
double	getDoubleValue(@NonNull Enum<?> valueID)	Returns the result of a given statistic.
void	onEvent(@NonNull Enum<?> type)	Updates the source, invoking the AbstractFunction.updateSource() method.

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

TYPE_DBL

protected static final int TYPE_DBL

See Also:

• Constant Field Values

TYPE_INT

protected static final int TYPE_INT

See Also:

• Constant Field Values

TYPE_LNG

protected static final int TYPE_LNG

See Also:

• Constant Field Values

dblSource

protected DoubleSource dblSource

intSource

protected IntSource intSource

lngSource

protected LongSource lngSource

type

protected int type

valueID

protected Enum<?> valueID

len

protected int len

values

protected double[] values

average

protected double average

valueCount

protected int valueCount

Constructor Details

MovingAverageTraceFunction

public MovingAverageTraceFunction(@NonNull
 @NonNull DoubleSource source,
 @NonNull
 @NonNull Enum<?> valueID,
 int windowSize)

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.

IllegalArgumentException - when windowSize is < 1.

MovingAverageTraceFunction

public MovingAverageTraceFunction(@NonNull
 @NonNull LongSource source,
 @NonNull
 @NonNull Enum<?> valueID,
 int windowSize)

Creates a basic statistic probe on a LongSource object.

Parameters:

source - The LongSource object.

valueID - The value identifier defined by source object.

Throws:

NullPointerException - when any of the input parameters is null.

IllegalArgumentException - when windowSize is < 1.

MovingAverageTraceFunction

public MovingAverageTraceFunction(@NonNull
 @NonNull IntSource source,
 @NonNull
 @NonNull Enum<?> valueID,
 int windowSize)

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

IllegalArgumentException - when windowSize is < 1.

Method Details

applyFunction

public void applyFunction()

Collects a value from the source.

Specified by:

applyFunction in class AbstractFunction

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 DoubleSource.Variables constants representing available statistics.

Returns:

The computed value.

Throws:

NullPointerException - when any of the input parameters is null.

onEvent

public void onEvent(@NonNull
 @NonNull Enum<?> type)

Updates the source, invoking the AbstractFunction.updateSource() method.

Specified by:

onEvent in interface EventListener

Overrides:

onEvent in class AbstractFunction

Parameters:

type - Accepts only the CommonEventType.UPDATE value.

Throws:

NullPointerException - when any of the input parameters is null.

SimulationRuntimeException - when type is of not supporter type.