Package org.eclipse.scanning.malcolm.core

Class AbstractMalcolmDevice

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.malcolm.core.AbstractMalcolmDevice

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:

DummyMalcolmDevice, MalcolmDevice

public abstract class AbstractMalcolmDevice
extends AbstractRunnableDevice<IMalcolmModel>
implements IMalcolmDevice, INexusDevice<NXobject>

Base class for Malcolm devices

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isMultiScan
protected String	outputDir
protected IPointGenerator<? extends IScanPointGeneratorModel>	pointGenerator
protected ScanModel	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

Modifier	Constructor	Description
protected	AbstractMalcolmDevice(IRunnableDeviceService runnableDeviceService)

Method Summary

Modifier and Type	Method	Description
void	addMalcolmListener(IMalcolmEventListener listener)	Add a listener to malcolm changes.
protected void	afterExecute()	Enacts any post-actions or conditions after the device completes a run of the task block.
protected void	beforeExecute()	Enacts any pre-actions or conditions before the device attempts to run the task block.
protected List<String>	calculateAxesToMove(List<String> configuredAxes)	Calculate the value of the axesToMove property of the EpicsMalcolmModel to send to malcolm, based on the given configured axes and the currently configured point generator
protected void	close()
void	configure(IMalcolmModel model)	Call to configure the device.
void	configureScan(ScanModel scanModel)
void	dispose()	Disposes of the malcolm device causing it to disconnect from the underlying malcolm device.
protected int[]	getBreakpoints()	The breakpoints array to pass to malcolm, only used with InterpolatedMultiScanModel, otherwise null.
List<String>	getConfiguredAxes()	Returns the axes that this malcolm device is currently configured to move.
List<String>	getConfiguredAxes(IMalcolmModel model)
ScanModel	getConfiguredScan()
DeviceInformation<IMalcolmModel>	getDeviceInformation(boolean includeNonAlive)	Do not override without calling super.getDeviceInformation() Method is final for now to help avoid that problem.
protected Optional<InterpolatedMultiScanModel>	getMultiScanModel()
List<NexusObjectProvider<NXobject>>	getNexusProviders(NexusScanInfo info)	Returns the object providers required for writing correct NeXus files.
String	getOutputDir()	Get the directory where malcolm will write its h5 files to.
IPointGenerator<? extends IScanPointGeneratorModel>	getPointGenerator()	Get the point generator that this malcolm device has been configured with
void	initialize()	Initializes the connection to the actual malcolm device.
void	register()	Used by spring to register the detector with the Runnable device service *WARNING* Before calling register the detector must be given a service to register this.
void	removeMalcolmListener(IMalcolmEventListener listener)	Remove a listener to malcolm changes.
void	scanFinally()
protected void	sendEvent(MalcolmEvent event)
void	setOutputDir(String outputDir)	Set the directory where malcolm will write its h5 files to.
void	setPointGenerator(IPointGenerator<? extends IScanPointGeneratorModel> pointGenerator)	Set the point generator for the malcolm device.
protected void	setTemplateBean(MalcolmEvent bean)
void	start(IPosition pos)	The default implementation of start simply executes run in a thread named using the getName() value.

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

abort, addRunListener, disable, fireRunPerformed, fireRunWillPerform, fireStateChanged, fireWritePerformed, fireWriteWillPerform, getConfigureTime, getConnectorService, getDeviceHealth, getDeviceInformation, getDeviceState, getLevel, getModel, getPublisher, getRole, getRunnableDeviceService, getScanAttribute, getScanAttributeNames, getScanId, getSupportedScanModes, isActivated, isAlive, isDeviceBusy, pause, removeRunListener, reset, resume, seek, setActivated, setAlive, setBusy, setConfigureTime, setConnectorService, setDeviceInformation, setDeviceState, setLevel, setModel, setPublisher, setRole, setRunnableDeviceService, setScanAttribute, setScanId, setSupportedScanMode, setSupportedScanModes, setSupportedScanModes, toString, validate

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.malcolm.IMalcolmDevice

getAvailableAxes, getDatasets, getDetectorInfos, getVersion, isLocked

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.IPausableDevice

pause, resume, seek

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

reset

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

abort, disable, getDeviceHealth, getDeviceState, getModel, isAlive, isDeviceBusy, latch, latch, run, 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, validate

Field Details

scanModel

protected ScanModel scanModel

pointGenerator

protected IPointGenerator<? extends IScanPointGeneratorModel> pointGenerator

outputDir

protected String outputDir

isMultiScan

protected boolean isMultiScan

Constructor Details

AbstractMalcolmDevice

protected AbstractMalcolmDevice(IRunnableDeviceService runnableDeviceService)

Method Details

register

public void register()

Description copied from class: AbstractRunnableDevice

Used by spring to register the detector with the Runnable device service *WARNING* Before calling register the detector must be given a service to register this. This can be done from the constructor super(IRunnableDeviceService) of the detector to make it easy to instantiate a no-argument detector and register it from spring.

Specified by:

register in interface INexusDevice<NXobject>

Overrides:

register in class AbstractRunnableDevice<IMalcolmModel>

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

Throws:

MalcolmDeviceException - if the malcolm device could not be initialized

configureScan

public void configureScan(ScanModel scanModel)

getBreakpoints

protected int[] getBreakpoints()

The breakpoints array to pass to malcolm, only used with InterpolatedMultiScanModel, otherwise null. The array has the same size as the number of models in the InterpolatedMultiScanModel, where each value is the number of points in the scan for that model

Returns:

breakpoints array

getConfiguredScan

public ScanModel getConfiguredScan()

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 AbstractRunnableDevice<IMalcolmModel>

Parameters:

model -

Throws:

ScanningException

getConfiguredAxes

public List<String> getConfiguredAxes()
                               throws ScanningException

Description copied from interface: IMalcolmDevice

Returns the axes that this malcolm device is currently configured to move. Normally, the value returned is the same as IMalcolmDevice.getAvailableAxes(), except if the last time that malcolm was configured by calling

invalid reference

IMalcolmDevice#configure(IMalcolmModel)

, IMalcolmModel.getAxesToMove() was non-null, in which case it is the

Specified by:

getConfiguredAxes in interface IMalcolmDevice

Returns:

the axes that the malcolm device is currently configured to move

Throws:

ScanningException

getConfiguredAxes

public List<String> getConfiguredAxes(IMalcolmModel model)
                               throws ScanningException

Throws:

ScanningException

calculateAxesToMove

protected List<String> calculateAxesToMove(List<String> configuredAxes)

Calculate the value of the axesToMove property of the EpicsMalcolmModel to send to malcolm, based on the given configured axes and the currently configured point generator

Parameters:

configuredAxes - the axes malcolm is or would have been configured with

Returns:

the axes that malcolm should move in the scan

setPointGenerator

public void setPointGenerator(IPointGenerator<? extends IScanPointGeneratorModel> pointGenerator)

Description copied from interface: IMalcolmDevice

Set the point generator for the malcolm device.

Specified by:

setPointGenerator in interface IMalcolmDevice

Parameters:

pointGenerator - point generator

getMultiScanModel

protected Optional<InterpolatedMultiScanModel> getMultiScanModel()

getPointGenerator

public IPointGenerator<? extends IScanPointGeneratorModel> getPointGenerator()

Description copied from interface: IMalcolmDevice

Get the point generator that this malcolm device has been configured with

Specified by:

getPointGenerator in interface IMalcolmDevice

Returns:

setOutputDir

public void setOutputDir(String outputDir)

Description copied from interface: IMalcolmDevice

Set the directory where malcolm will write its h5 files to. The directory should exist at the point that the malcolm device is configured, malcolm is not responsible for creating it.

Specified by:

setOutputDir in interface IMalcolmDevice

getOutputDir

public String getOutputDir()

Description copied from interface: IMalcolmDevice

Get the directory where malcolm will write its h5 files to.

Specified by:

getOutputDir in interface IMalcolmDevice

scanFinally

public void scanFinally()
                 throws ScanningException

Throws:

ScanningException

getDeviceInformation

public DeviceInformation<IMalcolmModel> getDeviceInformation(boolean includeNonAlive)
                                                      throws ScanningException

Description copied from class: AbstractRunnableDevice

Do not override without calling super.getDeviceInformation() Method is final for now to help avoid that problem. Gets the device information, with the ability to specify whether to get information that is potentially held on a device or not in the case that the device is not marked as being alive.

Overrides:

getDeviceInformation in class AbstractRunnableDevice<IMalcolmModel>

Parameters:

includeNonAlive - If set to false, if a device is not alive, information potentially held on the device will not be retrieved

Returns:

Throws:

ScanningException

beforeExecute

protected void beforeExecute()
                      throws Exception

Enacts any pre-actions or conditions before the device attempts to run the task block.

Throws:

Exception

afterExecute

protected void afterExecute()
                     throws Exception

Enacts any post-actions or conditions after the device completes a run of the task block.

Throws:

Exception

setTemplateBean

protected void setTemplateBean(MalcolmEvent bean)

start

public void start(IPosition pos)
           throws ScanningException,
InterruptedException

Description copied from interface: IRunnableDevice

The default implementation of start simply executes run in a thread named using the getName() value.

Specified by:

start in interface IRunnableDevice<IMalcolmModel>

Parameters:

pos -

Throws:

ScanningException

InterruptedException

close

protected void close()

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

Throws:

MalcolmDeviceException

getNexusProviders

public List<NexusObjectProvider<NXobject>> getNexusProviders(NexusScanInfo info)
                                                      throws NexusException

Description copied from interface: INexusDevice

Returns the object providers required for writing correct NeXus files. Implement this method if your device needs to create multiple nexus objects. These can implement NexusObjectProvider

The default implementation of this method calls INexusDevice.getNexusProvider(NexusScanInfo) and returns a List whose sole element is the NexusObjectProvider returned from that method. One of either this method or INexusDevice.getNexusProviders(NexusScanInfo) must be overridden to create and return the nexus object(s) for this INexusDevice.

Specified by:

getNexusProviders in interface INexusDevice<NXobject>

Parameters:

info - information about the scan which can be useful when creating datasets e.g. info.getRank()

Returns:

The NXobject created using the nodeFactory to represent this device

Throws:

NexusException - if the nexus object could not be created for any reason

addMalcolmListener

public void addMalcolmListener(IMalcolmEventListener listener)

Description copied from interface: IMalcolmDevice

Add a listener to malcolm changes.

Specified by:

addMalcolmListener in interface IMalcolmDevice

Parameters:

listener -

removeMalcolmListener

public void removeMalcolmListener(IMalcolmEventListener listener)

Description copied from interface: IMalcolmDevice

Remove a listener to malcolm changes.

Specified by:

removeMalcolmListener in interface IMalcolmDevice

Parameters:

listener -

sendEvent

protected void sendEvent(MalcolmEvent event)
                  throws Exception

Throws:

Exception