Package microsim.statistics

Class Series.Long

java.lang.Object

microsim.statistics.Series

microsim.statistics.Series.Long

All Implemented Interfaces:

EventListener, LongArraySource, UpdatableSource

Enclosing class:

Series

public static class Series.Long
extends Series
implements LongArraySource

Nested Class Summary

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

Series.Double, Series.Integer, Series.Long

Field Summary

Fields

Modifier and Type	Field	Description
protected LongSource	target
protected Enum<?>	valueID
protected microsim.statistics.Series.BufferedLongArrayList	valueList

Fields inherited from class microsim.statistics.Series

timeChecker

Constructor Summary

Constructors

Constructor	Description
Long(@NonNull Object source, @NonNull String valueName, boolean getFromMethod)	Creates a basic statistic probe on a collection of objects.
Long(@NonNull LongSource source)	Creates a statistic probe on a collection of LongSource objects.
Long(@NonNull LongSource source, @NonNull Enum<?> valueID)	Creates a statistic probe on a collection of LongSource objects.

Method Summary

Modifier and Type	Method	Description
double @NonNull []	getDoubleArray()
long @NonNull []	getLongArray()	Returns the currently cached array of long values.
@NonNull cern.mateba.list.tlong.LongArrayList	getLongArrayList()
@NonNull String	toString()
void	updateSource()	Forces the source to update its currently cached data.

Methods inherited from class microsim.statistics.Series

isCheckingTime, onEvent, setCheckingTime

Methods inherited from class java.lang.Object

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

Field Details

valueList

protected microsim.statistics.Series.BufferedLongArrayList valueList

target

protected LongSource target

valueID

protected Enum<?> valueID

Constructor Details

Long

public Long(@NonNull
 @NonNull LongSource source,
 @NonNull
 @NonNull Enum<?> valueID)

Creates a statistic probe on a collection of LongSource objects.

Parameters:

source - The collection containing LongSource object.

valueID - The value identifier defined by source object.

Throws:

NullPointerException - when any of the input parameters is null.

Long

public Long(@NonNull
 @NonNull LongSource source)

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

Parameters:

source - The collection containing LongSource object.

Throws:

NullPointerException - when source is null.

Long

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

Creates a basic statistic probe on a collection of objects.

Parameters:

source - A collection of generic objects.

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

getLongArray

public long @NonNull [] getLongArray()

Description copied from interface: LongArraySource

Returns the currently cached array of long values.

Specified by:

getLongArray in interface LongArraySource

Returns:

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

getDoubleArray

public double @NonNull [] getDoubleArray()

getLongArrayList

@NonNull
public @NonNull cern.mateba.list.tlong.LongArrayList getLongArrayList()

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

updateSource

public void updateSource()

Description copied from interface: UpdatableSource

Forces the source to update its currently cached data.

Specified by:

updateSource in interface UpdatableSource

Specified by:

updateSource in class Series