Package gda.device.insertiondevice

Class Apple2IDBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.insertiondevice.Apple2IDBase

All Implemented Interfaces:

Device, IApple2ID, Configurable, Findable, gda.observable.IObservable

Direct Known Subclasses:

Apple2IDDummy, Apple2IDEpics

public abstract class Apple2IDBase
extends DeviceBase
implements IApple2ID

This is the base class of a low-level controller for the AppleII ID.

It allows you to specify the ID gap and the position of the four phase motors and ensures that moves are made safely. Scannables can be built on top of this to allow the user to specify position in terms of, for example, gap invalid input: '&' polarisation or energy invalid input: '&' polarisation.

This version expects as input of Apple2IDPosition type.

The ID handles six polarisation modes described in Apple2IDPolarisationMode
LH is in fact a special case of Circular Mode with all motor positions equal to 0.

Moves between different modes must be made via LH: this class takes care of this requirement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	Apple2IDBase.IDMotor

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GAP_AND_PHASE_MODE

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Apple2IDBase()

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Apple2IDPosition position)
protected abstract void	doMove(Apple2IDPosition position)
double	getGapPositionTolerance()
double	getMaxGapPos()
double	getMaxPhaseMotorPos()
double	getMinGapPos()
protected abstract double	getMotorPosition(Apple2IDBase.IDMotor motor)
double	getMotorPositionTolerance()
Apple2IDPolarisationMode	getPolarisationMode(Apple2IDPosition position)
Apple2IDPosition	getPosition()
boolean	isBusy()
boolean	motorPositionsEqual(double a, double b)
protected void	onMoveFinished()	Subclasses should call this function when a single move has finished.
void	setGapPositionTolerance(double gapPositionTolerance)
void	setMaxGapPos(double maxGapPos)
void	setMaxPhaseMotorPos(double maxPhaseMotorPos)
void	setMinGapPos(double minGapPos)
void	setMotorPositionTolerance(double motorPositionTolerance)

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, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.insertiondevice.IApple2ID

getIDMode, isEnabled

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Field Details

GAP_AND_PHASE_MODE

protected static final String GAP_AND_PHASE_MODE

See Also:

• Constant Field Values

Constructor Details

Apple2IDBase

protected Apple2IDBase()

Method Details

asynchronousMoveTo

public void asynchronousMoveTo(Apple2IDPosition position)
                        throws DeviceException

Specified by:

asynchronousMoveTo in interface IApple2ID

Throws:

DeviceException

isBusy

public boolean isBusy()

Specified by:

isBusy in interface IApple2ID

getPosition

public Apple2IDPosition getPosition()
                             throws DeviceException

Specified by:

getPosition in interface IApple2ID

Throws:

DeviceException

motorPositionsEqual

public boolean motorPositionsEqual(double a,
 double b)

Specified by:

motorPositionsEqual in interface IApple2ID

onMoveFinished

protected void onMoveFinished()

Subclasses should call this function when a single move has finished.

getPolarisationMode

public Apple2IDPolarisationMode getPolarisationMode(Apple2IDPosition position)

Specified by:

getPolarisationMode in interface IApple2ID

doMove

protected abstract void doMove(Apple2IDPosition position)
                        throws DeviceException

Throws:

DeviceException

getMotorPosition

protected abstract double getMotorPosition(Apple2IDBase.IDMotor motor)
                                    throws DeviceException

Throws:

DeviceException

getMaxPhaseMotorPos

public double getMaxPhaseMotorPos()

Specified by:

getMaxPhaseMotorPos in interface IApple2ID

setMaxPhaseMotorPos

public void setMaxPhaseMotorPos(double maxPhaseMotorPos)

getMinGapPos

public double getMinGapPos()

setMinGapPos

public void setMinGapPos(double minGapPos)

getMaxGapPos

public double getMaxGapPos()

setMaxGapPos

public void setMaxGapPos(double maxGapPos)

getMotorPositionTolerance

public double getMotorPositionTolerance()

setMotorPositionTolerance

public void setMotorPositionTolerance(double motorPositionTolerance)

getGapPositionTolerance

public double getGapPositionTolerance()

setGapPositionTolerance

public void setGapPositionTolerance(double gapPositionTolerance)