Package gda.device.scannable

Class XesOffsets

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.scannable.XesOffsets

All Implemented Interfaces:

IXesOffsets, Configurable, Findable

@ServiceInterface(IXesOffsets.class)
public class XesOffsets
extends FindableConfigurableBase
implements IXesOffsets

This class is a replacement for the jython XESOffset, XESCalculate classes in xes_offset.py, xes_calculate.py.

Field Summary

Fields inherited from interface gda.exafs.xes.IXesOffsets

OFFSET_UPDATE_EVENT

Constructor Summary

Constructors

Constructor	Description
XesOffsets()

Method Summary

Modifier and Type	Method	Description
void	apply(String filename)	Apply offset settings saved in file to motors ('Load' button in xes calibration view)
void	applyFromLive(double fluoEnergy)	Calibrate the spectrometer : Assume that the spectrometer is currently aligned to specified energy, Calculate the extra offsets such that actual current position + offset = position needed for energy.
void	applyFromTemp()	Apply motor offsets using values in temporary file
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
String	getCurrentFile()	Used for 'Loaded offset file' textbox in xes calibration view.
ScannableGroup	getSpectrometerGroup()
String	getSpectrometerGroupName()
String	getStoreDirectory()
String	getTempSaveName()	Get name of temporary file
XESEnergyScannable	getXesEnergyScannable()
String	getXesEnergyScannableName()
void	reApply()	Re-apply offset parameters previously set using IXesOffsets.apply(String)
void	removeAll()	Set offsets on all motors to zero ('Remove offsets' button in xes calibration view)
void	saveAs(String filename)	Save current motor offset values to file.
void	saveToTemp()	Save current motor offsets to temporary file
void	setSpectrometerGroup(ScannableGroup spectrometerGroup)
void	setStoreDirectory(String storeDirectory)
void	setTempSaveName(String filename)	Set name of temporary file
void	setXesEnergyScannable(XESEnergyScannable xesEnergyScannable)

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Findable

getName, setName

Constructor Details

XesOffsets

public XesOffsets()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

applyFromLive

public void applyFromLive(double fluoEnergy)
                   throws DeviceException,
IOException

Calibrate the spectrometer :

Assume that the spectrometer is currently aligned to specified energy,

Calculate the extra offsets such that actual current position + offset = position needed for energy.

Save the offsets to temporary file. (Run by 'Calibrate' button in xes calibration view).

Specified by:

applyFromLive in interface IXesOffsets

Throws:

DeviceException

IOException

apply

public void apply(String filename)
           throws IOException

Apply offset settings saved in file to motors ('Load' button in xes calibration view)

Specified by:

apply in interface IXesOffsets

Throws:

IOException

reApply

public void reApply()
             throws IOException

Description copied from interface: IXesOffsets

Re-apply offset parameters previously set using IXesOffsets.apply(String)

Specified by:

reApply in interface IXesOffsets

Throws:

IOException

applyFromTemp

public void applyFromTemp()
                   throws IOException

Description copied from interface: IXesOffsets

Apply motor offsets using values in temporary file

Specified by:

applyFromTemp in interface IXesOffsets

Throws:

IOException

removeAll

public void removeAll()

Set offsets on all motors to zero ('Remove offsets' button in xes calibration view)

Specified by:

removeAll in interface IXesOffsets

saveAs

public void saveAs(String filename)
            throws IOException

Save current motor offset values to file. ('Save' button from xes calibration view)

Specified by:

saveAs in interface IXesOffsets

Throws:

IOException

saveToTemp

public void saveToTemp()
                throws IOException

Description copied from interface: IXesOffsets

Save current motor offsets to temporary file

Specified by:

saveToTemp in interface IXesOffsets

Throws:

IOException

getCurrentFile

public String getCurrentFile()

Used for 'Loaded offset file' textbox in xes calibration view.

Specified by:

getCurrentFile in interface IXesOffsets

Returns:

Name of current offset file

setTempSaveName

public void setTempSaveName(String filename)

Description copied from interface: IXesOffsets

Set name of temporary file

Specified by:

setTempSaveName in interface IXesOffsets

getTempSaveName

public String getTempSaveName()

Description copied from interface: IXesOffsets

Get name of temporary file

Specified by:

getTempSaveName in interface IXesOffsets

getSpectrometerGroupName

public String getSpectrometerGroupName()

Specified by:

getSpectrometerGroupName in interface IXesOffsets

getXesEnergyScannableName

public String getXesEnergyScannableName()

Specified by:

getXesEnergyScannableName in interface IXesOffsets

getStoreDirectory

public String getStoreDirectory()

setStoreDirectory

public void setStoreDirectory(String storeDirectory)

getSpectrometerGroup

public ScannableGroup getSpectrometerGroup()

setSpectrometerGroup

public void setSpectrometerGroup(ScannableGroup spectrometerGroup)

getXesEnergyScannable

public XESEnergyScannable getXesEnergyScannable()

setXesEnergyScannable

public void setXesEnergyScannable(XESEnergyScannable xesEnergyScannable)