Package etomica.data

Class AccumulatorHistory

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorHistory

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

public class AccumulatorHistory
extends DataAccumulator

Accumulator that keeps history of data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AccumulatorHistory.DataSourceCount	Simple DataSource to use as a default time DataSource.

Field Summary

Fields

Modifier and Type	Field	Description
protected History	history
protected int	nData
protected DataSourceIndependentSimple	xDataSources

Fields inherited from class etomica.data.DataAccumulator

active, hasUnpushedData, pushInterval, putCount

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
AccumulatorHistory()	Creates instance using HistorySimple factory and specifying historys having 100 bins.
AccumulatorHistory(History history)

Method Summary

Modifier and Type	Method	Description
protected boolean	addData(IData newData)	Adds each value in the given array to its own history.
IData	getData()	Returns the set of histories.
IDataInfo	getDataInfo()
History	getHistory()
DataSourceScalar	getTimeDataSource()	Returns the DataSource used for the "time" component of the history.
protected IDataInfo	processDataInfo(IDataInfo newInputDataInfo)	Sets up data and histories, discarding any previous results.
void	reset()	Clear accumulated values.
void	setHistory(History newHistory)
void	setTimeDataSource(DataSourceScalar newTimeDataSource)	Sets the DataSource used for the "time" component of the history.

Methods inherited from class etomica.data.DataAccumulator

getPushInterval, isActive, processData, setActive, setPushInterval, toString

Methods inherited from interface etomica.data.DataPipe

getTag

Methods inherited from class etomica.data.DataProcessor

getTag, 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

getTag

Methods inherited from class java.lang.Object

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

Field Detail

history

protected History history

xDataSources

protected DataSourceIndependentSimple xDataSources

nData

protected int nData

Constructor Detail

AccumulatorHistory

public AccumulatorHistory()

Creates instance using HistorySimple factory and specifying historys having 100 bins.

AccumulatorHistory

public AccumulatorHistory(History history)

Method Detail

getTimeDataSource

public DataSourceScalar getTimeDataSource()

Returns the DataSource used for the "time" component of the history.

setTimeDataSource

public void setTimeDataSource(DataSourceScalar newTimeDataSource)

Sets the DataSource used for the "time" component of the history. Each time addData is called, the time DataSource's getData will be called and the returned scalar will be taken as the current time. By default, the time variable is taken to be the number of times data was added to the history.

processDataInfo

protected IDataInfo processDataInfo(IDataInfo newInputDataInfo)

Sets up data and histories, discarding any previous results.

Specified by:

processDataInfo in class DataProcessor

Parameters:

newInputDataInfo -

Returns:

the DataInfo of the Data that will be output by this DataProcessor

addData

protected boolean addData(IData newData)

Adds each value in the given array to its own history. If the number of values is different from that given in previous calls to the method, old history data is discarded and new historys are constructed (this behavior can be modified by overriding the setNData method).

Specified by:

addData in class DataAccumulator

Parameters:

newData - the data to be processed

Returns:

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

getData

public IData getData()

Returns the set of histories.

Specified by:

getData in interface IDataSource

Specified by:

getData in class DataAccumulator

Returns:

the data given by this source

getHistory

public History getHistory()

setHistory

public void setHistory(History newHistory)

reset

public void reset()

Description copied from class: DataAccumulator

Clear accumulated values.

Specified by:

reset in class DataAccumulator

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

Overrides:

getDataInfo in class DataProcessor