Package gda.device.enumpositioner

Class EpicsSimpleBinary

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EpicsSimpleBinary

All Implemented Interfaces:

ControllerRecord, Device, EditableEnumPositioner, EnumPositioner, Scannable, Configurable, Findable, gda.observable.IObservable

@ServiceInterface(EnumPositioner.class)
public class EpicsSimpleBinary
extends EnumPositionerBase
implements EditableEnumPositioner, ControllerRecord

Similar to EpicsValve, except looks at a single pv which can only have positions 0 or 1.
The external names of these positions are names are read from Epics, but can be overwritten (though this is not encouraged)

EpicsValve should be used if the device uses the proper Epics Valve/Shutter template

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

Method Summary

Modifier and Type	Method	Description
String	checkPositionValid(Object position)	This default behaviour should be extended by most subclasses! This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands.
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.
String	getControllerRecordName()	Gets the name of the controller record, e.g.
Object	getPosition()	Returns the current position of the Scannable.
String	getPvName()
EnumPositionerStatus	getStatus()	Returns the current status
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.
void	setPositions(String[] newPositions)	Deprecated.
void	setPositions(Collection<String> positions)	Deprecated.
void	setPvName(String pvName)
void	setReadonly(boolean readonly)	Set to true to prevent attempts to change the pv through this class

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositions, getPositionsList, 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, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawGetPosition, 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.device.EnumPositioner

getPositions, getPositionsList, isInPos

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, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

EpicsSimpleBinary

public EpicsSimpleBinary()

Constructor

Method Details

setPvName

public void setPvName(String pvName)

getPvName

public String getPvName()

getControllerRecordName

public String getControllerRecordName()

Description copied from interface: ControllerRecord

Gets the name of the controller record, e.g. EPICS process variable name. For example, in NeXus this value can be written as the value of the controller_record field for the NXpositioner for the scannable.

Specified by:

getControllerRecordName in interface ControllerRecord

Returns:

controller record name

See Also:

• Nexus documentation for NXpositioner

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

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

See Also:

• EnumPositioner.getStatus()

setPositions

@Deprecated(since="GDA 9.8")
public void setPositions(String[] newPositions)

Deprecated.

Override the Epics values for the external names of the positions (deprecated).

Specified by:

setPositions in interface EditableEnumPositioner

Parameters:

newPositions - External names to set

setPositions

@Deprecated(since="GDA 9.8")
public void setPositions(Collection<String> positions)

Deprecated.

Override the Epics values for the external names of the positions (deprecated).

Specified by:

setPositions in interface EditableEnumPositioner

Parameters:

positions - External names to set

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

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

See Also:

• Scannable.getPosition()

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

See Also:

• Scannable.isBusy()

checkPositionValid

public String checkPositionValid(Object position)

Description copied from class: ScannableBase

This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands. May check limits and other things too. This is the method called by scans on all points before the scan is run.

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class EnumPositionerBase

Parameters:

position -

Returns:

null if position is valid, or returns a description if not.

See Also:

• Scannable.checkPositionValid(java.lang.Object)

setReadonly

public void setReadonly(boolean readonly)

Set to true to prevent attempts to change the pv through this class

Parameters:

readonly -