Package microsim.statistics

Class Series

java.lang.Object

microsim.statistics.Series

All Implemented Interfaces:

EventListener, UpdatableSource

Direct Known Subclasses:

Series.Double, Series.Integer, Series.Long

public abstract class Series
extends Object
implements EventListener, UpdatableSource

A series is a sequential collection of values coming from a given variable source over time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Series.Double
static class	Series.Integer
static class	Series.Long

Field Summary

Fields

Modifier and Type	Field	Description
protected TimeChecker	timeChecker

Constructor Summary

Constructors

Constructor	Description
Series()

Method Summary

Modifier and Type	Method	Description
boolean	isCheckingTime()	Returns the current status of the time checker.
void	onEvent(@NonNull Enum<?> type)	EventListener callback function.
void	setCheckingTime(boolean b)	Sets the current status of the time checker.
abstract void	updateSource()	Forces the source to update its currently cached data.

Methods inherited from class java.lang.Object

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

Field Details

timeChecker

protected TimeChecker timeChecker

Constructor Details

Series

public Series()

Method Details

updateSource

public abstract void updateSource()

Description copied from interface: UpdatableSource

Forces the source to update its currently cached data.

Specified by:

updateSource in interface UpdatableSource

onEvent

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

EventListener callback function. It supports only CommonEventType.UPDATE event.

Specified by:

onEvent in interface EventListener

Parameters:

type - The action id. Only CommonEventType.UPDATE is supported.

Throws:

UnsupportedOperationException - If actionType is not supported.

isCheckingTime

public boolean isCheckingTime()

Returns the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).

Returns:

True if the computer is currently checking time before update cached data, false if disabled.

setCheckingTime

public void setCheckingTime(boolean b)

Sets the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).

Parameters:

b - True if the computer is currently checking time before update cached data, false if disabled.