Package microsim.statistics

Class CrossSection.Double

java.lang.Object

microsim.statistics.CrossSection

microsim.statistics.CrossSection.Double

All Implemented Interfaces:

EventListener, DoubleArraySource, SourceObjectArray, UpdatableSource

Enclosing class:

CrossSection

public static class CrossSection.Double
extends CrossSection
implements DoubleArraySource

Nested Class Summary

Nested classes/interfaces inherited from class microsim.statistics.CrossSection

CrossSection.Double, CrossSection.Integer, CrossSection.Long

Field Summary

Fields

Modifier and Type	Field	Description
protected DoubleInvoker	invoker
protected Collection<?>	target
protected Enum<?>	valueID
protected double[]	valueList

Fields inherited from class microsim.statistics.CrossSection

filter, sourceArray, timeChecker

Constructor Summary

Constructors

Constructor	Description
Double(@NonNull Collection<?> source)	Creates a statistic probe on a collection of DoubleSource objects.
Double(@NonNull Collection<?> source, @NonNull Class<?> objectClass, @NonNull String valueName, boolean getFromMethod)	Creates a basic statistic probe on a collection of objects.
Double(@NonNull Collection<?> source, @NonNull Enum<?> valueID)	Creates a statistic probe on a collection of DoubleSource objects.

Method Summary

Modifier and Type	Method	Description
double @NonNull []	getDoubleArray()	Returns the currently cached array of double values.
@NonNull String	toString()
void	updateSource()	Updates the state of the object when it's not up-to-date.

Methods inherited from class microsim.statistics.CrossSection

isCheckingTime, onEvent, setCheckingTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface microsim.statistics.SourceObjectArray

getSourceArray

Field Details

valueList

protected double[] valueList

invoker

protected DoubleInvoker invoker

target

protected Collection<?> target

valueID

protected Enum<?> valueID

Constructor Details

Double

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

Creates a statistic probe on a collection of DoubleSource objects.

Parameters:

source - The collection containing 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 Collection<?> source)

Creates a statistic probe on a collection of DoubleSource objects. It uses the DoubleSource.Variables.DEFAULT variable id.

Parameters:

source - The collection containing DoubleSource object.

Throws:

NullPointerException - when source is null.

Double

public Double(@NonNull
 @NonNull Collection<?> source,
 @NonNull
 @NonNull Class<?> objectClass,
 @NonNull
 @NonNull String valueName,
 boolean getFromMethod)

Creates a basic statistic probe on a collection of objects.

Parameters:

source - A collection of generic objects.

objectClass - The class of the objects contained by collection source.

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

getDoubleArray

public double @NonNull [] getDoubleArray()

Description copied from interface: DoubleArraySource

Returns the currently cached array of double values.

Specified by:

getDoubleArray in interface DoubleArraySource

Returns:

An array of double or a null pointer if the source is empty.

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

updateSource

public void updateSource()

Updates the state of the object when it's not up-to-date.

Specified by:

updateSource in interface UpdatableSource

Specified by:

updateSource in class CrossSection