Package gda.device.enumpositioner

Class MapperBasedEnumPositionerBase<T>

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.MapperBasedEnumPositionerBase<T>

All Implemented Interfaces:

Device, EnumPositioner, Scannable, Configurable, Findable, gda.observable.IObservable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

IntegerMapperBasedEnumPositioner, StringMapperBasedEnumPositioner

public abstract class MapperBasedEnumPositionerBase<T>
extends EnumPositionerBase
implements org.springframework.beans.factory.InitializingBean

A class that acts as an EnumPositioner. It monitors a scannable that gives the current value of the 'hardware' in internal form. The class uses EnumValueMapper to map the external to internal forms moveTo accepts the position in external form. If a control scannable is provided then the moveTo calls moveTo on the control scannable with position set to the value in internal form If setCmdTemplate is provided then moveTo evaluates the command : String.format(getSetCmdTemplate(),newExternalValue, getInternalValue(newExternalValue)) Only one of control or setCmdTemplate can be set

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
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	getExternalValue(T internalValue)
protected abstract String	getExternalValueFromMonitor()
T	getInternalValue(String externalValue)
EnumValueMapper<T>	getMapper()
Scannable	getMonitor()
String	getPosition()	Returns the current position of the Scannable.
String[]	getPositions()	Returns an array of the positions which this device can be moved to.
protected abstract ScannablePositionChangeEvent	getScannablePositionChangeEvent(Object source, Object arg)
EnumPositionerStatus	getStatus()	Returns the current status
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setControl(Scannable control)
void	setMapper(EnumValueMapper<T> mapper)
void	setMonitor(Scannable monitor)
void	setSetCmdTemplate(String setCmdTemplate)

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositionsList, isBusy, 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.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, waitWhileBusy

Constructor Details

MapperBasedEnumPositionerBase

public MapperBasedEnumPositionerBase()

Method Details

getMapper

public EnumValueMapper<T> getMapper()

setMapper

public void setMapper(EnumValueMapper<T> mapper)

setSetCmdTemplate

public void setSetCmdTemplate(String setCmdTemplate)

setMonitor

public void setMonitor(Scannable monitor)

Parameters:

monitor - Scannable getPosition returns Integer and notifies observers with arg set to Integer

getMonitor

public Scannable getMonitor()

setControl

public void setControl(Scannable control)

Parameters:

control - Scannable whose moveTo accepts an Integer

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

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

getScannablePositionChangeEvent

protected abstract ScannablePositionChangeEvent getScannablePositionChangeEvent(Object source,
 Object arg)

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)

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

getPosition

public String 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

getExternalValueFromMonitor

protected abstract String getExternalValueFromMonitor()
                                               throws IllegalArgumentException,
DeviceException

Throws:

IllegalArgumentException

DeviceException

getInternalValue

public T getInternalValue(String externalValue)
                   throws IllegalArgumentException

Throws:

IllegalArgumentException

getExternalValue

public String getExternalValue(T internalValue)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

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