Package gda.data.scan.datawriter

Class XasAsciiNexusDataWriter

java.lang.Object

gda.data.scan.datawriter.DataWriterBase

gda.data.scan.datawriter.XasAsciiNexusDataWriter

All Implemented Interfaces:

ConfigurableAsciiFormat, DataWriter, IDataWriterExtender, INexusDataWriter

public class XasAsciiNexusDataWriter
extends DataWriterBase
implements ConfigurableAsciiFormat, INexusDataWriter

Write to an Xas and a Nexus file simultaneously

Field Summary

Fields inherited from class gda.data.scan.datawriter.DataWriterBase

delimiter, header, terminalPrinter

Constructor Summary

Constructors

Constructor	Description
XasAsciiNexusDataWriter()

Method Summary

Modifier and Type	Method	Description
void	addData(IScanDataPoint newData)	for incremental addition of data
void	addDataWriterExtender(IDataWriterExtender dataWriterExtender)	Adds an additional IDataWriterExtender to handle DataWriter events
void	completeCollection()	Called when data collection has been completed
void	configureScanNumber(int i)	If filenumber not set then read from scandatapoint or from num tracker
String	getAsciiFileName()
String	getAsciiFileNameTemplate()
AsciiDataWriterConfiguration	getConfiguration()
String	getCurrentFileName()	Get the absFilePath for this scan
int	getCurrentScanIdentifier()	Get the current scan identifier (ie scan number)
String	getDataDir()	Returns the full path of the folder which data files are written to.
List<String>	getDescriptions()
ArrayList<String>	getHeader()	header is a publicly accessible string which will be written to the file (or saved to a database) during the prepareForCollection method.
String	getNexusFileName()	The file name of the nexus file being written by this writer.
String	getNexusFileNameTemplate()
Boolean	getRunFromExperimentDefinition()
SwmrStatus	getSwmrStatus()	Returns a SwmrStatus object specifying the state of SWMR mode (single-write multiple-read) for the nexus file written by this writer.
void	removeDataWriterExtender(IDataWriterExtender dataWriterExtender)	Remove a IDataWriterExtender to handle DataWriter events.
void	setAsciiFileNameTemplate(String asciiFileNameTemplate)
void	setBeforeScanMetaData(INexusTree beforeScanMetadata)	Add an INexusTree to be written as before scan metadata.
void	setConfiguration(AsciiDataWriterConfiguration configuration)	Must be called before the first time addData is called (obviously?)
void	setDescriptions(List<String> descriptions)
void	setDetectorParametersName(String detectorParametersName)
void	setFolderName(String folderName)
void	setHeader(String header)	Sets the header of the datahandler
void	setNexusFileNameTemplate(String nexusFileNameTemplate)	Sets the template to use for the filename.
void	setOutputParametersName(String outputParametersName)
void	setRunFromExperimentDefinition(Boolean runFromExperimentDefinition)
void	setSampleName(String sampleName)
void	setSampleParametersName(String sampleParametersName)
void	setScanParametersName(String scanParametersName)

Methods inherited from class gda.data.scan.datawriter.DataWriterBase

addData, completeCollection, getDetectorData, getDetectorData, setHeader

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.data.scan.datawriter.DataWriter

scanStart, setHeader

Constructor Details

XasAsciiNexusDataWriter

public XasAsciiNexusDataWriter()

Method Details

configureScanNumber

public void configureScanNumber(int i)

Description copied from class: DataWriterBase

If filenumber not set then read from scandatapoint or from num tracker

Specified by:

configureScanNumber in interface DataWriter

Overrides:

configureScanNumber in class DataWriterBase

Parameters:

i -

getCurrentFileName

public String getCurrentFileName()

Description copied from interface: DataWriter

Get the absFilePath for this scan

Specified by:

getCurrentFileName in interface DataWriter

Returns:

String

getAsciiFileName

public String getAsciiFileName()

getCurrentScanIdentifier

public int getCurrentScanIdentifier()

Description copied from interface: DataWriter

Get the current scan identifier (ie scan number)

Specified by:

getCurrentScanIdentifier in interface DataWriter

Returns:

String

setHeader

public void setHeader(String header)

Description copied from interface: DataWriter

Sets the header of the datahandler

Specified by:

setHeader in interface DataWriter

Parameters:

header - String

addData

public void addData(IScanDataPoint newData)
             throws Exception

Description copied from interface: DataWriter

for incremental addition of data

Specified by:

addData in interface DataWriter

Overrides:

addData in class DataWriterBase

Parameters:

newData - Object

Throws:

Exception

completeCollection

public void completeCollection()
                        throws Exception

Description copied from interface: DataWriter

Called when data collection has been completed

Specified by:

completeCollection in interface DataWriter

Overrides:

completeCollection in class DataWriterBase

Throws:

Exception

getHeader

public ArrayList<String> getHeader()

Description copied from interface: DataWriter

header is a publicly accessible string which will be written to the file (or saved to a database) during the prepareForCollection method. Before this method is called, the header object may be added to using these accessor methods.

Specified by:

getHeader in interface DataWriter

Overrides:

getHeader in class DataWriterBase

Returns:

an ArrayList containing header information

addDataWriterExtender

public void addDataWriterExtender(IDataWriterExtender dataWriterExtender)

Description copied from interface: DataWriter

Adds an additional IDataWriterExtender to handle DataWriter events

Specified by:

addDataWriterExtender in interface DataWriter

Specified by:

addDataWriterExtender in interface IDataWriterExtender

Overrides:

addDataWriterExtender in class DataWriterBase

Parameters:

dataWriterExtender -

removeDataWriterExtender

public void removeDataWriterExtender(IDataWriterExtender dataWriterExtender)

Description copied from interface: DataWriter

Remove a IDataWriterExtender to handle DataWriter events.

Specified by:

removeDataWriterExtender in interface DataWriter

Specified by:

removeDataWriterExtender in interface IDataWriterExtender

Overrides:

removeDataWriterExtender in class DataWriterBase

Parameters:

dataWriterExtender -

getConfiguration

public AsciiDataWriterConfiguration getConfiguration()

Specified by:

getConfiguration in interface ConfigurableAsciiFormat

setConfiguration

public void setConfiguration(AsciiDataWriterConfiguration configuration)

Description copied from interface: ConfigurableAsciiFormat

Must be called before the first time addData is called (obviously?)

Specified by:

setConfiguration in interface ConfigurableAsciiFormat

Parameters:

configuration -

getNexusFileNameTemplate

public String getNexusFileNameTemplate()

setNexusFileNameTemplate

public void setNexusFileNameTemplate(String nexusFileNameTemplate)

Description copied from interface: INexusDataWriter

Sets the template to use for the filename. This should use the string String.format(String, Object...) pattern, with a single format specifier %s, e.g. ixx-%d.nxs.

Specified by:

setNexusFileNameTemplate in interface INexusDataWriter

Parameters:

nexusFileNameTemplate -

getAsciiFileNameTemplate

public String getAsciiFileNameTemplate()

setAsciiFileNameTemplate

public void setAsciiFileNameTemplate(String asciiFileNameTemplate)

getDescriptions

public List<String> getDescriptions()

setDescriptions

public void setDescriptions(List<String> descriptions)

setSampleName

public void setSampleName(String sampleName)

setScanParametersName

public void setScanParametersName(String scanParametersName)

setSampleParametersName

public void setSampleParametersName(String sampleParametersName)

setDetectorParametersName

public void setDetectorParametersName(String detectorParametersName)

setOutputParametersName

public void setOutputParametersName(String outputParametersName)

setFolderName

public void setFolderName(String folderName)

getRunFromExperimentDefinition

public Boolean getRunFromExperimentDefinition()

setRunFromExperimentDefinition

public void setRunFromExperimentDefinition(Boolean runFromExperimentDefinition)

getNexusFileName

public String getNexusFileName()

Description copied from interface: INexusDataWriter

The file name of the nexus file being written by this writer.

Specified by:

getNexusFileName in interface INexusDataWriter

Returns:

file name of nexus file

getDataDir

public String getDataDir()

Description copied from interface: INexusDataWriter

Returns the full path of the folder which data files are written to.

Specified by:

getDataDir in interface INexusDataWriter

Returns:

the full path of the folder which data files are written

getSwmrStatus

public SwmrStatus getSwmrStatus()

Description copied from interface: INexusDataWriter

Returns a SwmrStatus object specifying the state of SWMR mode (single-write multiple-read) for the nexus file written by this writer. See the javadoc for SwmrStatus for details.

Specified by:

getSwmrStatus in interface INexusDataWriter

Returns:

the SwmrStatus

setBeforeScanMetaData

public void setBeforeScanMetaData(INexusTree beforeScanMetadata)

Description copied from interface: INexusDataWriter

Add an INexusTree to be written as before scan metadata. TODO: do we need this method. It doesn't seem to be used, but may potentially be useful?

Specified by:

setBeforeScanMetaData in interface INexusDataWriter

Parameters:

beforeScanMetadata -