Package gda.device.scannable

Class FastAttenuatorFilters

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.FastAttenuatorFilters

All Implemented Interfaces:

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

public class FastAttenuatorFilters
extends ScannableBase

Class managing the filters of FastAttenuatorScannable. This extends ScannableBase so it can be added to the metadata easily.

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
FastAttenuatorFilters()

Method Summary

Modifier and Type	Method	Description
double	getCurrentTransmission(Integer attenuation)
Function<Integer,Double>	getCurrentTransmissionFunction()	Get reference to the transmission function.
String	getFilterSet()
List<Double>	getFilterTransmissions()
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	setBasePv(String basePV)
void	setFilterSet(String filterSetName)
void	setFilterTransmissions(Double[] filterTransmissions)	Set the transmissions of the current filter set.
void	setHistogramThresholdsBasePv(String histogramThresholdsBasePv)

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, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, 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

FastAttenuatorFilters

public FastAttenuatorFilters()

Method Details

setBasePv

public void setBasePv(String basePV)

setHistogramThresholdsBasePv

public void setHistogramThresholdsBasePv(String histogramThresholdsBasePv)

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

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()

setFilterSet

public void setFilterSet(String filterSetName)
                  throws IOException

Throws:

IOException

getFilterSet

public String getFilterSet()
                    throws IOException

Throws:

IOException

getCurrentTransmission

public double getCurrentTransmission(Integer attenuation)

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

getCurrentTransmissionFunction

public Function<Integer,Double> getCurrentTransmissionFunction()

Get reference to the transmission function. This is to allow this to be injected to be used in a scanning processor without requiring a dependency on this plugin directly.