Package uk.ac.gda.beamline.i19.server.api.scannable

Class EH2ShutterControl

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

uk.ac.gda.beamline.i19.server.api.scannable.EH2ShutterControl

All Implemented Interfaces:

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

@ServiceInterface(ShutterController.class)
public final class EH2ShutterControl
extends ScannableBase
implements ShutterController, gda.observable.IObserver

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EH2_SHUTTER_CLOSED
static final String	EH2_SHUTTER_OPEN

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

Fields inherited from interface gda.gui.mx.ShutterController

SHUTTER_CLOSED, SHUTTER_OPEN

Method Summary

Modifier and Type	Method	Description
void	closeShutter()
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.
Scannable	getTheShutter()
boolean	isAutoDryOptional()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isShutterOpen()
void	operateShutter()	the same as pressing the button
void	operateShutterOptionalAutoDry(boolean autoDry)
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setOperateShutterCmd(String operateShutterCmd)
void	setShutterScriptController(Scriptcontroller shutterScriptController)
void	setTheShutter(EnumPositioner theShutter)
void	stop()	Stop the current move/operation.
void	update(Object source, Object arg)

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

Field Details

EH2_SHUTTER_OPEN

public static final String EH2_SHUTTER_OPEN

See Also:

• Constant Field Values

EH2_SHUTTER_CLOSED

public static final String EH2_SHUTTER_CLOSED

See Also:

• Constant Field Values

Method Details

setTheShutter

public void setTheShutter(EnumPositioner theShutter)

setShutterScriptController

public void setShutterScriptController(Scriptcontroller shutterScriptController)

setOperateShutterCmd

public void setOperateShutterCmd(String operateShutterCmd)

getTheShutter

public Scannable getTheShutter()

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

operateShutter

public void operateShutter()
                    throws DeviceException

Description copied from interface: ShutterController

the same as pressing the button

Specified by:

operateShutter in interface ShutterController

Throws:

DeviceException

isShutterOpen

public boolean isShutterOpen()
                      throws DeviceException

Specified by:

isShutterOpen in interface ShutterController

Returns:

true if the experimental shutter is open

Throws:

DeviceException

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

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

Throws:

DeviceException

closeShutter

public void closeShutter()
                  throws DeviceException

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

operateShutterOptionalAutoDry

public void operateShutterOptionalAutoDry(boolean autoDry)
                                   throws DeviceException

Specified by:

operateShutterOptionalAutoDry in interface ShutterController

Throws:

DeviceException

isAutoDryOptional

public boolean isAutoDryOptional()
                          throws DeviceException

Specified by:

isAutoDryOptional in interface ShutterController

Throws:

DeviceException