Package org.eclipse.scanning.malcolm.core

Class MalcolmDevice

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.device.AbstractRunnableDevice<IMalcolmModel>

org.eclipse.scanning.malcolm.core.AbstractMalcolmDevice

org.eclipse.scanning.malcolm.core.MalcolmDevice

All Implemented Interfaces:

INexusDevice<NXobject>, IActivatable, IPausableDevice<IMalcolmModel>, IResettableDevice, IRunnableDevice<IMalcolmModel>, IRunnableEventDevice<IMalcolmModel>, IDeviceRoleActor, IConfigurable<IMalcolmModel>, ILevel, IModelProvider<IMalcolmModel>, INameable, IScanAttributeContainer, IValidator<IMalcolmModel>, IMalcolmDevice

Direct Known Subclasses:

ProcessingMalcolmDevice

public class MalcolmDevice
extends AbstractMalcolmDevice

Object that make the connection to the device and monitors its status.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_NAME_COMPLETED_STEPS
static final String	ATTRIBUTE_NAME_LAST_GOOD_STEP
static final String	FILE_EXTENSION_H5
static final long	POSITION_COMPLETE_INTERVAL
static final String	STANDARD_MALCOLM_ERROR_STR

Fields inherited from class org.eclipse.scanning.malcolm.core.AbstractMalcolmDevice

isMultiScan, outputDir, pointGenerator, scanModel

Fields inherited from class org.eclipse.scanning.api.device.AbstractRunnableDevice

connectorService, model, runnableDeviceService

Fields inherited from interface org.eclipse.scanning.api.ILevel

MAXIMUM

Constructor Summary

Constructors

Constructor	Description
MalcolmDevice()
MalcolmDevice(String name, IMalcolmConnection malcolmConnection, IRunnableDeviceService runnableDeviceService)

Method Summary

Modifier and Type	Method	Description
void	abort()	Call to terminate the scan before it has finished.
void	closeFile()	At the end of a scan, Malcolm remains in a FINISHED state until reset() is called.
void	configure(IMalcolmModel model)	Call to configure the device.
void	disable()	Call to disable the device, stopping all activity.
void	dispose()	Disposes of the malcolm device causing it to disconnect from the underlying malcolm device.
List<String>	getAvailableAxes()	Returns the axes that this malcolm device can move.
MalcolmTable	getDatasets()	Returns a MalcolmTable object describing the datasets that this malcolm device is configured to create during a scan.
List<MalcolmDetectorInfo>	getDetectorInfos()	Returns the MalcolmDetectorInfos for the detectors controlled by this malcolm device, describing their current state.
String	getDeviceHealth()	Please override to provide a device health (which a malcolm device will have) The default returns null.
DeviceState	getDeviceState()	Overrides IRunnableDevice.getDeviceState() to ask the actual malcolm device for the device state.
DeviceState	getLatestDeviceState()	Returns the most recent device state from malcolm.
IMalcolmModel	getModel()	The model being used for the device.
SeekStrategy	getSeekStrategy()
MalcolmVersion	getVersion()	Returns the version of this malcolm device.
protected void	handleStateChange(DeviceState newState, String message)
protected void	handleStateChange(MalcolmMessage message)
protected void	handleStepsCompleted(MalcolmMessage message)
void	initialize()	Initializes the connection to the actual malcolm device.
boolean	isDeviceBusy()	Gets whether the device is busy or not
boolean	isLocked()	Attempts to determine if the device is locked doing something like a configure or a run.
void	pause()	Pauses the device.
void	reset()	Allowed from Fault.
void	resume()	Allowed when the device is in Paused state.
void	run(IPosition pos)	Blocking call to execute the scan.
void	seek(int stepNumber)	Seek to/from a point number (absolute) in the scan.
static void	setResetAfterScan(boolean resetAfterScan)
void	setSeekStrategy(SeekStrategy strategy)	It this is set, it will calculate the scan point the device should resume from based on the last scan point and other device parameters.
IMalcolmModel	validate(IMalcolmModel model)	If overriding don't forget the old super.validate(...)

Methods inherited from class org.eclipse.scanning.malcolm.core.AbstractMalcolmDevice

addMalcolmListener, afterExecute, beforeExecute, calculateAxesToMove, close, configureScan, getBreakpoints, getConfiguredAxes, getConfiguredAxes, getConfiguredScan, getDeviceInformation, getMultiScanModel, getNexusProviders, getOutputDir, getPointGenerator, register, removeMalcolmListener, scanFinally, sendEvent, setOutputDir, setPointGenerator, setTemplateBean, start

Methods inherited from class org.eclipse.scanning.api.device.AbstractRunnableDevice

addRunListener, fireRunPerformed, fireRunWillPerform, fireStateChanged, fireWritePerformed, fireWriteWillPerform, getConfigureTime, getConnectorService, getDeviceInformation, getLevel, getPublisher, getRole, getRunnableDeviceService, getScanAttribute, getScanAttributeNames, getScanId, getSupportedScanModes, isActivated, isAlive, removeRunListener, setActivated, setAlive, setBusy, setConfigureTime, setConnectorService, setDeviceInformation, setDeviceState, setLevel, setModel, setPublisher, setRole, setRunnableDeviceService, setScanAttribute, setScanId, setSupportedScanMode, setSupportedScanModes, setSupportedScanModes, toString

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.device.models.IDeviceRoleActor

getRole, getSupportedScanModes, setRole

Methods inherited from interface org.eclipse.scanning.api.ILevel

getLevel, setLevel

Methods inherited from interface org.eclipse.scanning.api.IModelProvider

setModel, updateModel

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Methods inherited from interface org.eclipse.dawnsci.nexus.INexusDevice

getCustomNexusModification, getName, getNexusProvider

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableDevice

isAlive, latch, latch, run, setAlive, throwFirstRunException

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableEventDevice

addRunListener, fireRunPerformed, fireRunWillPerform, fireWritePerformed, fireWriteWillPerform, removeRunListener

Methods inherited from interface org.eclipse.scanning.api.IValidator

setService

Field Details

ATTRIBUTE_NAME_COMPLETED_STEPS

public static final String ATTRIBUTE_NAME_COMPLETED_STEPS

See Also:

• Constant Field Values

ATTRIBUTE_NAME_LAST_GOOD_STEP

public static final String ATTRIBUTE_NAME_LAST_GOOD_STEP

See Also:

• Constant Field Values

FILE_EXTENSION_H5

public static final String FILE_EXTENSION_H5

See Also:

• Constant Field Values

STANDARD_MALCOLM_ERROR_STR

public static final String STANDARD_MALCOLM_ERROR_STR

See Also:

• Constant Field Values

POSITION_COMPLETE_INTERVAL

public static final long POSITION_COMPLETE_INTERVAL

Constructor Details

MalcolmDevice

public MalcolmDevice()

MalcolmDevice

public MalcolmDevice(String name,
 IMalcolmConnection malcolmConnection,
 IRunnableDeviceService runnableDeviceService)

Method Details

initialize

public void initialize()
                throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Initializes the connection to the actual malcolm device. This methods must be called before the malcolm device can be used.

Specified by:

initialize in interface IMalcolmDevice

Overrides:

initialize in class AbstractMalcolmDevice

Throws:

MalcolmDeviceException - if the malcolm device could not be initialized

handleStepsCompleted

protected void handleStepsCompleted(MalcolmMessage message)

handleStateChange

protected void handleStateChange(MalcolmMessage message)

handleStateChange

protected void handleStateChange(DeviceState newState,
 String message)

getLatestDeviceState

public DeviceState getLatestDeviceState()
                                 throws ScanningException

Returns the most recent device state from malcolm. This returns the device state from the most recently state change from the actual malcolm device. This value returned from this method is the same value that MalcolmStateChangedEvent.getPreviousState() will be in the next such event.

Returns:

latest device state of the malcolm device

Throws:

ScanningException

getDeviceState

public DeviceState getDeviceState()
                           throws MalcolmDeviceException

Overrides IRunnableDevice.getDeviceState() to ask the actual malcolm device for the device state.

Specified by:

getDeviceState in interface IRunnableDevice<IMalcolmModel>

Overrides:

getDeviceState in class AbstractRunnableDevice<IMalcolmModel>

Returns:

the device state of the malcolm device

Throws:

MalcolmDeviceException

getModel

public IMalcolmModel getModel()

Description copied from interface: IRunnableDevice

The model being used for the device.

Specified by:

getModel in interface IModelProvider<IMalcolmModel>

Specified by:

getModel in interface IRunnableDevice<IMalcolmModel>

Overrides:

getModel in class AbstractRunnableDevice<IMalcolmModel>

Returns:

getDetectorInfos

public List<MalcolmDetectorInfo> getDetectorInfos()

Description copied from interface: IMalcolmDevice

Returns the MalcolmDetectorInfos for the detectors controlled by this malcolm device, describing their current state.

Returns:

detector infos

getDeviceHealth

public String getDeviceHealth()
                       throws MalcolmDeviceException

Description copied from class: AbstractRunnableDevice

Please override to provide a device health (which a malcolm device will have) The default returns null.

Specified by:

getDeviceHealth in interface IRunnableDevice<IMalcolmModel>

Overrides:

getDeviceHealth in class AbstractRunnableDevice<IMalcolmModel>

Returns:

the current device Health.

Throws:

MalcolmDeviceException

isDeviceBusy

public boolean isDeviceBusy()
                     throws MalcolmDeviceException

Description copied from class: AbstractRunnableDevice

Gets whether the device is busy or not

Specified by:

isDeviceBusy in interface IRunnableDevice<IMalcolmModel>

Overrides:

isDeviceBusy in class AbstractRunnableDevice<IMalcolmModel>

Returns:

the current value of the device 'busy' flag.

Throws:

MalcolmDeviceException

validate

public IMalcolmModel validate(IMalcolmModel model)
                       throws ValidationException

Description copied from class: AbstractRunnableDevice

If overriding don't forget the old super.validate(...)

Specified by:

validate in interface IValidator<IMalcolmModel>

Overrides:

validate in class AbstractRunnableDevice<IMalcolmModel>

Parameters:

model - - a model of type T to validate

Returns:

a valid model

Throws:

ValidationException

configure

public void configure(IMalcolmModel model)
               throws ScanningException

Description copied from interface: IConfigurable

Call to configure the device. If the model provided is invalid, a scanning exception will be thrown.

Specified by:

configure in interface IConfigurable<IMalcolmModel>

Overrides:

configure in class AbstractMalcolmDevice

Parameters:

model -

Throws:

ScanningException

run

public void run(IPosition pos)
         throws MalcolmDeviceException

Description copied from interface: IRunnableDevice

Blocking call to execute the scan. The position specified may be null.

Throws:

MalcolmDeviceException

seek

public void seek(int stepNumber)
          throws MalcolmDeviceException

Description copied from interface: IPausableDevice

Seek to/from a point number (absolute) in the scan.

Specified by:

seek in interface IPausableDevice<IMalcolmModel>

Overrides:

seek in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

abort

public void abort()
           throws MalcolmDeviceException

Description copied from interface: IRunnableDevice

Call to terminate the scan before it has finished.

Specified by:

abort in interface IRunnableDevice<IMalcolmModel>

Overrides:

abort in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

disable

public void disable()
             throws MalcolmDeviceException

Description copied from interface: IRunnableDevice

Call to disable the device, stopping all activity.

Specified by:

disable in interface IRunnableDevice<IMalcolmModel>

Overrides:

disable in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

reset

public void reset()
           throws MalcolmDeviceException

Description copied from interface: IResettableDevice

Allowed from Fault. Will try to reset the device into Idle state. Will block until the device is in a rest state.

Specified by:

reset in interface IResettableDevice

Overrides:

reset in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

pause

public void pause()
           throws MalcolmDeviceException

Pauses the device. The implementation delegates to #seek, resulting in a PAUSE command to Malcolm. The default SeekStrategy instructs Malcolm to eventually resume from the last scan point.

Specified by:

pause in interface IPausableDevice<IMalcolmModel>

Overrides:

pause in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

resume

public void resume()
            throws MalcolmDeviceException

Description copied from interface: IPausableDevice

Allowed when the device is in Paused state. Will block until the device is unpaused. When paused the same thread must call resume() or abort() which has paused or an IllegalMonitorState Exception will be thrown.

Specified by:

resume in interface IPausableDevice<IMalcolmModel>

Overrides:

resume in class AbstractRunnableDevice<IMalcolmModel>

Throws:

MalcolmDeviceException

dispose

public void dispose()
             throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Disposes of the malcolm device causing it to disconnect from the underlying malcolm device.

Specified by:

dispose in interface IMalcolmDevice

Overrides:

dispose in class AbstractMalcolmDevice

Throws:

MalcolmDeviceException

getVersion

public MalcolmVersion getVersion()
                          throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Returns the version of this malcolm device.

Returns:

version

Throws:

MalcolmDeviceException - if the version cannot be returned for any reason

isLocked

public boolean isLocked()
                 throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Attempts to determine if the device is locked doing something like a configure or a run.

Returns:

true if not in locked state, otherwise false.

Throws:

MalcolmDeviceException

getAvailableAxes

public List<String> getAvailableAxes()
                              throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Returns the axes that this malcolm device can move.

Returns:

the axes this malcolm device can move, never null

Throws:

MalcolmDeviceException

getDatasets

public MalcolmTable getDatasets()
                         throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

Returns a MalcolmTable object describing the datasets that this malcolm device is configured to create during a scan. This method should only be called after

invalid reference

#configure(IMalcolmModel)

has been called on this malcolm device.

Returns:

a table of the datasets created by this malcolm device

Throws:

MalcolmDeviceException - if the datasets table could not be returned for any reason

setResetAfterScan

public static void setResetAfterScan(boolean resetAfterScan)

getSeekStrategy

public SeekStrategy getSeekStrategy()

setSeekStrategy

public void setSeekStrategy(SeekStrategy strategy)

It this is set, it will calculate the scan point the device should resume from based on the last scan point and other device parameters. Otherwise, the default value is -1, indicating the device should resume from the last scanned position.

closeFile

public void closeFile()
               throws MalcolmDeviceException

At the end of a scan, Malcolm remains in a FINISHED state until reset() is called. Only at this point will Malcolm close the file.

Throws:

MalcolmDeviceException