Package gda.device.detector

Class DAServerStatusChecker

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DAServerStatusChecker

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyDAServerStatusChecker

public class DAServerStatusChecker
extends ScannableBase

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, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
DAServerStatusChecker()

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
boolean	checkStatus()	Check DAServer is available and running correctly, by running checkStatus(String, int) using host and port information from DAServer reference (set using setDaServer(DAServer)).
boolean	checkStatus(String host, int port)	Check DAServer running on specified host and port to ensure it is available and produces correct response.
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.
DAServer	getDaServer()
String	getStatusMessage()
boolean	isBusy()	Check if the Scannable is moving/operating.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setDaServer(DAServer daServer)
void	setStatusMessage(String statusMessage)

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, 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

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

Constructor Details

DAServerStatusChecker

public DAServerStatusChecker()

Method Details

configure

public void configure()

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

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException - if DAServer is not available

See Also:

• Scannable.atScanStart()

checkStatus

public boolean checkStatus()

Check DAServer is available and running correctly, by running checkStatus(String, int) using host and port information from DAServer reference (set using setDaServer(DAServer)).

Returns:

true if DAServer is available

checkStatus

public boolean checkStatus(String host,
 int port)

Check DAServer running on specified host and port to ensure it is available and produces correct response. statusMessage contains more information about the result of the check.

Parameters:

host -

port -

Returns:

true if DAServer is running ok, false otherwise

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

asynchronousMoveTo

public void asynchronousMoveTo(Object position)

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.

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

getDaServer

public DAServer getDaServer()

setDaServer

public void setDaServer(DAServer daServer)

getStatusMessage

public String getStatusMessage()

setStatusMessage

public void setStatusMessage(String statusMessage)