Package uk.ac.gda.analysis.mscan

Class ProcessingMalcolmDevice

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

uk.ac.gda.analysis.mscan.ProcessingMalcolmDevice

All Implemented Interfaces:

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

public class ProcessingMalcolmDevice
extends MalcolmDevice

Extension of Malcolm device to allow live processing to be performed within GDA This is achieved using SwmrMalcolmProcessingReader responsible for reading frames as they are available and passing the datasets into any defined processors

Field Summary

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

ATTRIBUTE_NAME_COMPLETED_STEPS, ATTRIBUTE_NAME_LAST_GOOD_STEP, FILE_EXTENSION_H5, POSITION_COMPLETE_INTERVAL, 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
ProcessingMalcolmDevice()

Method Summary

Modifier and Type	Method	Description
void	closeProc()
HklAdapter	getHklProvider()
List<NexusObjectProvider<NXobject>>	getNexusProviders(NexusScanInfo info)	Returns the object providers required for writing correct NeXus files.
MalcolmProcessingManager	getProcessing()
List<MalcolmSwmrProcessor<?>>	getProcessors()
void	setHklProvider(HklAdapter hklProvider)
void	setProcessing(MalcolmProcessingManager processing)
void	startSwmrReader()
void	stopSwmr()
void	writeHkl()

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

abort, closeFile, configure, disable, dispose, getAvailableAxes, getDatasets, getDetectorInfos, getDeviceHealth, getDeviceState, getLatestDeviceState, getModel, getSeekStrategy, getVersion, handleStateChange, handleStateChange, handleStepsCompleted, initialize, isDeviceBusy, isLocked, pause, reset, resume, run, seek, setResetAfterScan, setSeekStrategy, validate

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

addMalcolmListener, afterExecute, beforeExecute, calculateAxesToMove, close, configureScan, getBreakpoints, getConfiguredAxes, getConfiguredAxes, getConfiguredScan, getDeviceInformation, getMultiScanModel, 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

Constructor Details

ProcessingMalcolmDevice

public ProcessingMalcolmDevice()

Method Details

startSwmrReader

public void startSwmrReader()

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>

Overrides:

getNexusProviders in class AbstractMalcolmDevice

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

writeHkl

public void writeHkl()

stopSwmr

public void stopSwmr()

closeProc

public void closeProc()

getHklProvider

public HklAdapter getHklProvider()

setHklProvider

public void setHklProvider(HklAdapter hklProvider)

getProcessing

public MalcolmProcessingManager getProcessing()

setProcessing

public void setProcessing(MalcolmProcessingManager processing)

getProcessors

public List<MalcolmSwmrProcessor<?>> getProcessors()