Package gda.device.timer

Class TfgChannelEnum

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.timer.TfgChannelEnum

All Implemented Interfaces:

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

@ServiceInterface(EnumPositioner.class)
public class TfgChannelEnum
extends EnumPositionerBase
implements gda.observable.IObserver

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

Method Summary

Modifier and Type	Method	Description
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.
int	getChannel()
String	getHighName()
String	getLowName()
String[]	getPositions()	Returns an array of the positions which this device can be moved to.
List<String>	getPositionsList()	Returns a list of the positions which this device can be moved to.
EnumPositionerStatus	getStatus()	Returns the current status
Etfg	getTfg()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setChannel(int channel)
void	setHighName(String highName)
void	setLowName(String lowName)
void	setTfg(Etfg tfg)
void	update(Object source, Object arg)

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, isInPos, setPositionerStatus, setPositionsInternal, toFormattedString

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, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, 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

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, 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, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy

Constructor Details

TfgChannelEnum

public TfgChannelEnum()

Method Details

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class EnumPositionerBase

Returns:

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

Throws:

DeviceException

getPositions

public String[] getPositions()
                      throws DeviceException

Description copied from interface: EnumPositioner

Returns an array of the positions which this device can be moved to.

Specified by:

getPositions in interface EnumPositioner

Overrides:

getPositions in class EnumPositionerBase

Returns:

an array of positions

Throws:

DeviceException

getPositionsList

public List<String> getPositionsList()

Description copied from interface: EnumPositioner

Returns a list of the positions which this device can be moved to.

Specified by:

getPositionsList in interface EnumPositioner

Overrides:

getPositionsList in class EnumPositionerBase

Returns:

a list of positions

getStatus

public EnumPositionerStatus getStatus()
                               throws DeviceException

Description copied from interface: EnumPositioner

Returns the current status

Specified by:

getStatus in interface EnumPositioner

Overrides:

getStatus in class EnumPositionerBase

Returns:

the status

Throws:

DeviceException

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

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 ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

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

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getChannel

public int getChannel()

setChannel

public void setChannel(int channel)

getHighName

public String getHighName()

setHighName

public void setHighName(String highName)

getLowName

public String getLowName()

setLowName

public void setLowName(String lowName)

getTfg

public Etfg getTfg()

setTfg

public void setTfg(Etfg tfg)