Package org.opengda.lde.scannables

Class Spinner

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

org.opengda.lde.scannables.Spinner

All Implemented Interfaces:

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

public class Spinner
extends ScannableBase
implements ISpin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Spinner.ONOFF

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

Constructor Summary

Constructors

Constructor	Description
Spinner()

Method Summary

Modifier and Type	Method	Description
String	getOnOffPV()
Object	getPosition()	Returns the current position of the Scannable.
double	getSpeed()	get spin speed
String	getState()	check spin state - i.e.
String	getVoltagePV()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	off()	disable spin or switch off spin
void	on()	enable spin or switch on spin
void	setOnOffPV(String onOffPV)
void	setSpeed(double voltage)	set spin speed
void	setVoltagePV(String voltagePV)

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

Methods inherited from interface gda.device.Scannable

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

Constructor Details

Spinner

public Spinner()

Method Details

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

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Returns:

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

Throws:

DeviceException

on

public void on()
        throws DeviceException

Description copied from interface: ISpin

enable spin or switch on spin

Specified by:

on in interface ISpin

Throws:

DeviceException

off

public void off()
         throws DeviceException

Description copied from interface: ISpin

disable spin or switch off spin

Specified by:

off in interface ISpin

Throws:

DeviceException

setSpeed

public void setSpeed(double voltage)
              throws DeviceException

Description copied from interface: ISpin

set spin speed

Specified by:

setSpeed in interface ISpin

Parameters:

voltage -

Throws:

DeviceException

getSpeed

public double getSpeed()
                throws DeviceException

Description copied from interface: ISpin

get spin speed

Specified by:

getSpeed in interface ISpin

Returns:

spin speed

Throws:

DeviceException

getState

public String getState()
                throws DeviceException

Description copied from interface: ISpin

check spin state - i.e. Enabled or Disabled

Specified by:

getState in interface ISpin

Returns:

spin state

Throws:

DeviceException

getOnOffPV

public String getOnOffPV()

setOnOffPV

public void setOnOffPV(String onOffPV)

getVoltagePV

public String getVoltagePV()

setVoltagePV

public void setVoltagePV(String voltagePV)