Package gda.device.scannable

Class FastAttenuatorScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.FastAttenuatorScannable

All Implemented Interfaces:

Device, Scannable, Configurable, Findable, gda.observable.IObservable

public class FastAttenuatorScannable
extends ScannableBase

Scannable for the fast attenuator filters on i07.

Field Summary

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, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
FastAttenuatorScannable()

Method Summary

Modifier and Type	Method	Description
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
void	continuousMode()
double	getCurrentTransmission()	Get the transmission value of the currently in use filters.
String	getFilterSet()
List<Double>	getFilterTransmissions()
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	manualMode()
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setAttenuation(int filtersPresent)	Sets which filters the attenuator is currently using.
void	setBasePv(String basePV)
void	setFilterManager(FastAttenuatorFilters filters)
void	setFilterSet(String filterSetName)
void	setFilterTransmissions(Double[] filterTransmissions)	Set the transmissions of the current filter set.
void	singleShotMode()

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toFormattedString, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

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

Methods inherited from class gda.factory.ConfigurableBase

configure, 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

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Constructor Details

FastAttenuatorScannable

public FastAttenuatorScannable()

Method Details

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

setBasePv

public void setBasePv(String basePV)

setFilterManager

public void setFilterManager(FastAttenuatorFilters filters)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

setAttenuation

public void setAttenuation(int filtersPresent)
                    throws DeviceException

Sets which filters the attenuator is currently using.

Parameters:

filtersPresent - a value 0-15 describing which filters to use.

Throws:

DeviceException

setFilterTransmissions

public void setFilterTransmissions(Double[] filterTransmissions)

Set the transmissions of the current filter set.

Parameters:

filterTransmissions - array of four filter transmissions.

getFilterTransmissions

public List<Double> getFilterTransmissions()

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)
                           throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.

Overrides:

rawAsynchronousMoveTo in class ScannableBase

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

getCurrentTransmission

public double getCurrentTransmission()
                              throws IOException

Get the transmission value of the currently in use filters.

Returns:

the current transmission.

Throws:

IOException

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

setFilterSet

public void setFilterSet(String filterSetName)
                  throws IOException

Throws:

IOException

getFilterSet

public String getFilterSet()
                    throws IOException

Throws:

IOException

manualMode

public void manualMode()
                throws IOException,
IllegalStateException,
TimeoutException,
InterruptedException

Throws:

IOException

IllegalStateException

TimeoutException

InterruptedException

continuousMode

public void continuousMode()
                    throws IOException,
IllegalStateException,
TimeoutException,
InterruptedException

Throws:

IOException

IllegalStateException

TimeoutException

InterruptedException

singleShotMode

public void singleShotMode()
                    throws IOException,
IllegalStateException,
TimeoutException,
InterruptedException

Throws:

IOException

IllegalStateException

TimeoutException

InterruptedException