Package gda.device.epicsdevice

Class EpicsRecord

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.epicsdevice.EpicsRecord

All Implemented Interfaces:

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

public class EpicsRecord
extends ScannableBase
implements IEpicsChannel

EpicsRecord Class

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

Method Summary

Modifier and Type	Method	Description
void	addIObserver(gda.observable.IObserver anIObserver)
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
EpicsRegistrationRequest	buildRequest()
void	deleteIObserver(gda.observable.IObserver anIObserver)
void	deleteIObservers()
void	dispose()
Object	getValue()
Object	getValue(ReturnType _returnType, String subField)
String	getValueAsString()
String	getValueAsString(String subField)
boolean	isBusy()	Check if the Scannable is moving/operating.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setReturnValAsString(Boolean returnValAsString)
void	setValue(Object position)
void	setValue(String subField, Object position)

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

Methods inherited from class gda.device.DeviceBase

close, 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.device.Scannable

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

Method Details

setReturnValAsString

public void setReturnValAsString(Boolean returnValAsString)

dispose

public void dispose()

Specified by:

dispose in interface IEpicsChannel

See Also:

• IEpicsChannel.dispose()

buildRequest

public EpicsRegistrationRequest buildRequest()

Returns:

EpicsRegistrationRequest

addIObserver

public void addIObserver(gda.observable.IObserver anIObserver)

Specified by:

addIObserver in interface gda.observable.IObservable

Overrides:

addIObserver in class DeviceBase

See Also:

• DeviceBase.addIObserver(gda.observable.IObserver)

deleteIObserver

public void deleteIObserver(gda.observable.IObserver anIObserver)

Specified by:

deleteIObserver in interface gda.observable.IObservable

Overrides:

deleteIObserver in class DeviceBase

See Also:

• DeviceBase.deleteIObserver(gda.observable.IObserver)

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

Overrides:

deleteIObservers in class DeviceBase

See Also:

• DeviceBase.deleteIObservers()

getValue

public Object getValue()
                throws DeviceException

Specified by:

getValue in interface IEpicsChannel

Returns:

value

Throws:

DeviceException

See Also:

• IEpicsChannel.getValue()

getValue

public Object getValue(ReturnType _returnType,
 String subField)
                throws DeviceException

Parameters:

_returnType -

subField -

Returns:

Object

Throws:

DeviceException

getValueAsString

public String getValueAsString()
                        throws DeviceException

Returns:

String

Throws:

DeviceException

getValueAsString

public String getValueAsString(String subField)
                        throws DeviceException

Parameters:

subField -

Returns:

String

Throws:

DeviceException

setValue

public void setValue(Object position)
              throws DeviceException

Specified by:

setValue in interface IEpicsChannel

Parameters:

position -

Throws:

DeviceException

See Also:

• IEpicsChannel.setValue(java.lang.Object)

setValue

public void setValue(String subField,
 Object position)
              throws DeviceException

Parameters:

subField -

position -

Throws:

DeviceException

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class ScannableBase

Parameters:

position - Position to move to should have an element for each input field.

Throws:

DeviceException

See Also:

• ScannableBase.asynchronousMoveTo(java.lang.Object)

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

isBusy

public boolean isBusy()

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

See Also:

• Scannable.isBusy()