Package etomica.data

Class DataLogger

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataLogger

All Implemented Interfaces:

DataPipe, IDataSink

public class DataLogger
extends DataProcessor

DataSink that manages a FileWriter and also listens to non-interval integrator events and sends appropriate data to a DataWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataLogger.DataWriter	Interface for a DataSink that actually writes data to a file

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	fileNameSuffix
protected java.io.FileWriter	fileWriter

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataLogger()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()
void	closeFile()
protected java.lang.String	defaultFileName()
java.lang.String	getFileName()
int	getWriteInterval()
IDataSource	getWriteOnFinishDataSource()
boolean	isAppending()
boolean	isCloseFileEachTime()
boolean	isSameFileEachTime()
boolean	isWriteOnInterval()
IData	processData(IData data)	Gives data to DataSink for writing
IDataInfo	processDataInfo(IDataInfo newDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	putData(IData data)	Performs the open/write/close file actions in accordance with the settings of the Logger.
void	setAppending(boolean appending)	Overwrite or attach the data to the file.
void	setCloseFileEachTime(boolean closeFileEachTime)	Close the file and open a new one at each time INTERVAL.
void	setDataSink(IDataSink dataSink)	Sets the sink receiving the data.
void	setFileName(java.lang.String fileName)	Define the name of the output file.
void	setSameFileEachTime(boolean sameFileEachTime)	Write to the same file at each time INTERVAL, and close the file at the end of the simulation.
void	setWriteInterval(int newWriteInterval)	Define how many number of interval events received between writings to file.
void	setWriteOnFinish(IDataSource newWriteOnFinishSource)
void	setWriteOnInterval(boolean writeOnInterval)

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putDataInfo

Methods inherited from class java.lang.Object

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

Field Detail

fileWriter

protected transient java.io.FileWriter fileWriter

fileNameSuffix

protected java.lang.String fileNameSuffix

Constructor Detail

DataLogger

public DataLogger()

Method Detail

setDataSink

public void setDataSink(IDataSink dataSink)

Description copied from class: DataProcessor

Sets the sink receiving the data. Null value is permitted.

Specified by:

setDataSink in interface DataPipe

Overrides:

setDataSink in class DataProcessor

Parameters:

dataSink - The data sink to set.

processData

public IData processData(IData data)

Gives data to DataSink for writing

Specified by:

processData in class DataProcessor

Parameters:

data - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)

processDataInfo

public IDataInfo processDataInfo(IDataInfo newDataInfo)

Description copied from class: DataProcessor

Informs this DataProcessor of the DataInfo for the Data it will be processing. Typically the subclass will use this information to make any objects or otherwise prepare for calls to processData.

Specified by:

processDataInfo in class DataProcessor

Parameters:

newDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

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

cleanUp

public void cleanUp()

putData

public void putData(IData data)

Performs the open/write/close file actions in accordance with the settings of the Logger. Called by intervalAction and by the actionPerformed method of any Actions made by the writeAction method.

Specified by:

putData in interface IDataSink

Overrides:

putData in class DataProcessor

getWriteInterval

public int getWriteInterval()

setWriteInterval

public void setWriteInterval(int newWriteInterval)

Define how many number of interval events received between writings to file.

defaultFileName

protected java.lang.String defaultFileName()

closeFile

public void closeFile()

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

Define the name of the output file.

isAppending

public boolean isAppending()

setAppending

public void setAppending(boolean appending)

Overwrite or attach the data to the file. Default is to append, not overwrite.

isSameFileEachTime

public boolean isSameFileEachTime()

setSameFileEachTime

public void setSameFileEachTime(boolean sameFileEachTime)

Write to the same file at each time INTERVAL, and close the file at the end of the simulation. Default is true.

isCloseFileEachTime

public boolean isCloseFileEachTime()

setCloseFileEachTime

public void setCloseFileEachTime(boolean closeFileEachTime)

Close the file and open a new one at each time INTERVAL. The new file will be named by defaultFileName().

getWriteOnFinishDataSource

public IDataSource getWriteOnFinishDataSource()

Returns:

Returns the writeOnFinish.

setWriteOnFinish

public void setWriteOnFinish(IDataSource newWriteOnFinishSource)

Parameters:

newWriteOnFinishSource - The writeOnFinish to set.

isWriteOnInterval

public boolean isWriteOnInterval()

Returns:

Returns the writeOnInterval.

setWriteOnInterval

public void setWriteOnInterval(boolean writeOnInterval)

Parameters:

writeOnInterval - The writeOnInterval to set.