Package org.opengda.lde.scannables

Class DataReductionScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.DummyScannable

org.opengda.lde.scannables.DataReductionScannable

All Implemented Interfaces:

INeXusInfoWriteable, ControllerRecord, Device, Scannable, ScannableMotion, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver

@ServiceInterface(Scannable.class)
public class DataReductionScannable
extends DummyScannable
implements gda.observable.IObserver

Field Summary

Fields inherited from class gda.device.scannable.DummyScannable

currentPosition, increment

Fields inherited from class gda.device.scannable.ScannableMotionBase

numberTries, tolerance

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Fields inherited from interface gda.device.ScannableMotion

FIRSTINPUTLIMITS

Constructor Summary

Constructors

Constructor	Description
DataReductionScannable()

Method Summary

Modifier and Type	Method	Description
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	close()	Close and unconfigure the device.
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	getCurrentCalibrantDataFilename()
StringValueScannable	getCurrentCalibrationScannable()
Scriptcontroller	getEventAdmin()
String	getSampleID()
SimpleUDPServerScannable	getSimpleUDPServer()
boolean	isCalibrant()
void	setCalibrant(boolean calibrant)
void	setCurrentCalibrantDataFilename(String calibrantFilename)
void	setCurrentCalibrationScannable(StringValueScannable currentCalibrationScannable)
void	setEventAdmin(Scriptcontroller eventAdmin)
void	setSampleID(String sampleID)
void	setSimpleUDPServer(SimpleUDPServerScannable simpleUDPServer)
void	update(Object source, Object arg)

Methods inherited from class gda.device.scannable.DummyScannable

getControllerRecordName, getPosition, isBusy, rawAsynchronousMoveTo, rawGetPosition, setControllerRecordName, setIncrement, setName

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, getAttribute, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, internalToExternal, isAt, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, toFormattedString, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy

Constructor Details

DataReductionScannable

public DataReductionScannable()

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

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

atScanEnd

public void atScanEnd()

Description copied from class: ScannableBase

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class ScannableBase

See Also:

• Scannable.atScanEnd()

getEventAdmin

public Scriptcontroller getEventAdmin()

setEventAdmin

public void setEventAdmin(Scriptcontroller eventAdmin)

isCalibrant

public boolean isCalibrant()

setCalibrant

public void setCalibrant(boolean calibrant)

getCurrentCalibrantDataFilename

public String getCurrentCalibrantDataFilename()

setCurrentCalibrantDataFilename

public void setCurrentCalibrantDataFilename(String calibrantFilename)

getCurrentCalibrationScannable

public StringValueScannable getCurrentCalibrationScannable()

setCurrentCalibrationScannable

public void setCurrentCalibrationScannable(StringValueScannable currentCalibrationScannable)

getSimpleUDPServer

public SimpleUDPServerScannable getSimpleUDPServer()

setSimpleUDPServer

public void setSimpleUDPServer(SimpleUDPServerScannable simpleUDPServer)

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getSampleID

public String getSampleID()

setSampleID

public void setSampleID(String sampleID)