Package gda.data.scan.datawriter

Class XasAsciiDataWriter

java.lang.Object

gda.data.scan.datawriter.DataWriterBase

gda.data.scan.datawriter.IncrementalFile

gda.data.scan.datawriter.AsciiDataWriter

gda.data.scan.datawriter.XasAsciiDataWriter

All Implemented Interfaces:

ConfigurableAsciiFormat, DataWriter, IDataWriterExtender

public class XasAsciiDataWriter
extends AsciiDataWriter

Extension to the asciidatawriter which uses xml files if defined which have more options specific to the exafs RCP GUI as used on spectroscopy beamlines

Field Summary

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

columnHeader, configuration

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

currentFileName, dataDir, file, fileExtension, fileName, fileNumberConfigured, filePrefix, fileUrl, firstData, thisFileNumber

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

delimiter, header, terminalPrinter

Constructor Summary

Constructors

Constructor	Description
XasAsciiDataWriter(int fileNumber)

Method Summary

Modifier and Type	Method	Description
void	addData(IScanDataPoint dataPoint)	The Xas scan should have columns ordered as follows: Fluorescence: Energy I0 It Iref ln(I0/It) ln(I0/Iref) FF FF/I0 time Transmission: Energy I0 It Iref ln(I0/It) ln(I0/Iref) time
void	createNextFile()	Closes current file and opens a new file with an incremental number.
String	getAsciiFileNameTemplate()
List<String>	getDescriptions()
String	getDetectorParametersName()
String	getFolderName()
String	getNexusFilePath()
String	getOutputParameters()
Boolean	getRunFromExperimentDefinition()
String	getSampleName()
String	getSampleParametersName()
String	getScanParametersName()
void	setAsciiFileNameTemplate(String asciiFileNameTemplate)	This must also include the subdirectory
void	setDescriptions(List<String> descriptions)
void	setDetectorParametersName(String detectorParametersName)
void	setFolderName(String folderName)
void	setNexusFilePath(String nexusFilePath)
void	setOutputParametersName(String outputParametersName)
void	setRunFromExperimentDefinition(Boolean runFromExperimentDefinition)
void	setSampleName(String sampleName)
void	setSampleParametersName(String sampleParametersName)
void	setScanParametersName(String scanParametersName)
void	writeHeader()	This should be extended by inheriting classes.

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

getConfiguration, getScanDataPointFormatter, setConfiguration, setHeader, setScanDataPointFormatter, setupFile, writeColumnHeadings, writeFooter

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

completeCollection, configureScanNumber, destroy, getCurrentFileName, getCurrentScanIdentifier, getDataDir, getDelimiter, getFileNumber, prepareForCollection, releaseFile, setDelimiter, setFilePrefix

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

addData, addDataWriterExtender, completeCollection, getDetectorData, getDetectorData, getHeader, removeDataWriterExtender, 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

addDataWriterExtender, completeCollection, configureScanNumber, getCurrentFileName, getCurrentScanIdentifier, getHeader, removeDataWriterExtender, scanStart, setHeader

Constructor Details

XasAsciiDataWriter

public XasAsciiDataWriter(int fileNumber)
                   throws InstantiationException

Throws:

InstantiationException

Method Details

createNextFile

public void createNextFile()
                    throws Exception

Description copied from class: IncrementalFile

Closes current file and opens a new file with an incremental number. For use when many files being created instead of a single file being appended to.

Overrides:

createNextFile in class IncrementalFile

Throws:

Exception

writeHeader

public void writeHeader()

Description copied from class: IncrementalFile

This should be extended by inheriting classes.

Overrides:

writeHeader in class AsciiDataWriter

addData

public void addData(IScanDataPoint dataPoint)
             throws Exception

The Xas scan should have columns ordered as follows: Fluorescence: Energy I0 It Iref ln(I0/It) ln(I0/Iref) FF FF/I0 time Transmission: Energy I0 It Iref ln(I0/It) ln(I0/Iref) time

Specified by:

addData in interface DataWriter

Overrides:

addData in class AsciiDataWriter

Parameters:

dataPoint - Object

Throws:

Exception

getDescriptions

public List<String> getDescriptions()

setDescriptions

public void setDescriptions(List<String> descriptions)

getRunFromExperimentDefinition

public Boolean getRunFromExperimentDefinition()

setRunFromExperimentDefinition

public void setRunFromExperimentDefinition(Boolean runFromExperimentDefinition)

getSampleName

public String getSampleName()

setSampleName

public void setSampleName(String sampleName)

getAsciiFileNameTemplate

public String getAsciiFileNameTemplate()

setAsciiFileNameTemplate

public void setAsciiFileNameTemplate(String asciiFileNameTemplate)

This must also include the subdirectory

Parameters:

asciiFileNameTemplate -

getNexusFilePath

public String getNexusFilePath()

setNexusFilePath

public void setNexusFilePath(String nexusFilePath)

getScanParametersName

public String getScanParametersName()

setScanParametersName

public void setScanParametersName(String scanParametersName)

getSampleParametersName

public String getSampleParametersName()

setSampleParametersName

public void setSampleParametersName(String sampleParametersName)

getDetectorParametersName

public String getDetectorParametersName()

setDetectorParametersName

public void setDetectorParametersName(String detectorParametersName)

getOutputParameters

public String getOutputParameters()

setOutputParametersName

public void setOutputParametersName(String outputParametersName)

getFolderName

public String getFolderName()

setFolderName

public void setFolderName(String folderName)