Package etomica.data

Class DataAccumulator

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

Direct Known Subclasses:

AccumulatorAutocorrelationPTensor, AccumulatorAutocorrelationShearStress, AccumulatorAverage, AccumulatorAverageBlockless, AccumulatorAverageBlocklessSlim, AccumulatorAverageBootstrap, AccumulatorAverageCollapsingLog, AccumulatorCounter, AccumulatorHistogram, AccumulatorHistory

public abstract class DataAccumulator
extends DataProcessorForked
implements IDataSource

DataProcessor that accumulates and transforms given data and intermittently transmits processed data to other DataSink(s). As a DataSink in a data stream, this instance will take data given to it and perform some action using it (for example, accumulating an average or other statistics, updating a histogram). After a specified number of times, this instance will push the accumulated data to DataSink(s) that have been added to it.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active	Flag specifying whether the manager responds to integrator events
protected boolean	hasUnpushedData
protected long	pushInterval	Accumulated data are pushed to the data sinks after every pushInterval calls
protected long	putCount	Counter that keeps track of the number of interval events received since last call to updateSums

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataAccumulator()	Constructs accumulator with no initial DataSink.

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	addData(IData data)	Defined by subclass to specify what this accumulator does when data is added to it.
abstract IData	getData()
long	getPushInterval()	Accumulated data are pushed to the data sinks after every pushInterval calls to putData.
boolean	isActive()
protected IData	processData(IData inputData)	Returns getData() every pushInterval times it is invoked, otherwise returns null (thereby preventing transmission of data to the next DataSinks).
abstract void	reset()	Clear accumulated values.
void	setActive(boolean active)
void	setPushInterval(long i)	Accumulated data are pushed to the data sinks after every pushInterval calls to putData.
java.lang.String	toString()

Methods inherited from interface etomica.data.DataPipe

getTag

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getTag, processDataInfo, putData, putDataInfo

Methods inherited from class etomica.data.DataProcessorForked

addDataSink, getDataSink, getDataSinks, removeDataSink, setDataSink, setDataSinks

Methods inherited from interface etomica.data.IDataSink

putData, putDataInfo

Methods inherited from interface etomica.data.IDataSource

getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Field Detail

putCount

protected long putCount

Counter that keeps track of the number of interval events received since last call to updateSums

pushInterval

protected long pushInterval

Accumulated data are pushed to the data sinks after every pushInterval calls

active

protected boolean active

Flag specifying whether the manager responds to integrator events

hasUnpushedData

protected boolean hasUnpushedData

Constructor Detail

DataAccumulator

public DataAccumulator()

Constructs accumulator with no initial DataSink. The default pushInterval is 1 and isActive() is true.

Method Detail

addData

protected abstract boolean addData(IData data)

Defined by subclass to specify what this accumulator does when data is added to it.

Parameters:

data - the data to be processed

Returns:

true if the Accumulator's getData method will now return different data.

reset

public abstract void reset()

Clear accumulated values.

getData

public abstract IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

processData

protected IData processData(IData inputData)

Returns getData() every pushInterval times it is invoked, otherwise returns null (thereby preventing transmission of data to the next DataSinks). If isActive is false, data is not accumulated and no action is performed.

Specified by:

processData in class DataProcessor

Parameters:

inputData - data to be processed.

Returns:

processed data

isActive

public boolean isActive()

Returns:

true if accumulation is being performed in response to interval events.

setActive

public final void setActive(boolean active)

Parameters:

active - Sets whether accumulation is to be performed in response to interval events.

getPushInterval

public final long getPushInterval()

Accumulated data are pushed to the data sinks after every pushInterval calls to putData. Default value is 1, meaning that accumulated Data is pushed every time putData is called.

Returns:

the current value of pushInterval.

setPushInterval

public final void setPushInterval(long i)

Accumulated data are pushed to the data sinks after every pushInterval calls to putData. This method sets the pushInterval, and argument must be greater than zero. Default value is 1, meaning that every call to putData causes accumulator data to be pushed to its sink.

Parameters:

i - the pushInterval to be set.

Throws:

java.lang.IllegalArgumentException - if argument is less than or equal to zero.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the output of dataInfo.getLabel() + " accumulator"