Package gda.device.scannable

Class TwoJawSlitGap

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

gda.device.scannable.TwoJawSlitPosition

gda.device.scannable.TwoJawSlitGap

All Implemented Interfaces:

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

@ServiceInterface(ScannableMotionUnits.class)
public class TwoJawSlitGap
extends TwoJawSlitPosition

The gap of a two jaw slit.

Based on TwoJawSlitPosition.

Field Summary

Fields inherited from class gda.device.scannable.TwoJawSlitPosition

firstJaw, firstJawName, secondJaw, secondJawName

Fields inherited from class gda.device.scannable.ScannableMotionUnitsBase

unitsComponent

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

Fields inherited from interface gda.device.ScannableMotionUnits

HARDWAREUNITS, USERUNITS

Constructor Summary

Constructors

Constructor	Description
TwoJawSlitGap()

Method Summary

Modifier and Type	Method	Description
protected javax.measure.Quantity<javax.measure.quantity.Length>[]	calculateTargets(Object position)	given a position, where should the motors be moved to?
protected double[]	getLimits(javax.measure.Quantity<javax.measure.quantity.Length> firstJawMin, javax.measure.Quantity<javax.measure.quantity.Length> firstJawMax, javax.measure.Quantity<javax.measure.quantity.Length> secondJawMin, javax.measure.Quantity<javax.measure.quantity.Length> secondJawMax)
String	getXmlparametersfilename()
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setXmlparametersfilename(String xmlparametersfilename)	This string is the name of the xml parameters file which is used to store the beam centre used by these slits.

Methods inherited from class gda.device.scannable.TwoJawSlitPosition

asynchronousMoveTo, calculateLimits, checkPositionValid, configure, getCurrentGap, getCurrentPosition, getFirstJaw, getFirstJawName, getSecondJaw, getSecondJawName, isBusy, moveTo, setFirstJaw, setFirstJawName, setSecondJaw, setSecondJawName, stop, update, userUnitFromUnitsComponent

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

addAcceptableUnit, externalToInternal, getAcceptableUnits, getAttribute, getHardwareUnitString, getInitialUserUnits, getOffset, getUserUnits, internalToExternal, isAt, setHardwareUnitString, setInitialUserUnits, setOffset, setOffset, setUserUnits, toFormattedString

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

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

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, 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

close, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

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

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, r, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits

Constructor Details

TwoJawSlitGap

public TwoJawSlitGap()

Method Details

getLimits

protected double[] getLimits(javax.measure.Quantity<javax.measure.quantity.Length> firstJawMin,
 javax.measure.Quantity<javax.measure.quantity.Length> firstJawMax,
 javax.measure.Quantity<javax.measure.quantity.Length> secondJawMin,
 javax.measure.Quantity<javax.measure.quantity.Length> secondJawMax)

Overrides:

getLimits in class TwoJawSlitPosition

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class TwoJawSlitPosition

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

setXmlparametersfilename

public void setXmlparametersfilename(String xmlparametersfilename)

This string is the name of the xml parameters file which is used to store the beam centre used by these slits. If this value is set to a non-null value then the behaviour of this scannable is changed to move the gap based on the beam centre in this xml file rather than use the current beam centre. This is useful for motors which drift or frequently fail.

Parameters:

xmlparametersfilename - The xmlparametersfilename to set.

getXmlparametersfilename

public String getXmlparametersfilename()

Returns:

Returns the xmlparametersfilename.

calculateTargets

protected javax.measure.Quantity<javax.measure.quantity.Length>[] calculateTargets(Object position)
                                                                            throws DeviceException

Description copied from class: TwoJawSlitPosition

given a position, where should the motors be moved to?

Overrides:

calculateTargets in class TwoJawSlitPosition

Parameters:

position -

Returns:

Quantity[2]

Throws:

DeviceException