Package org.eclipse.scanning.example.malcolm

Class DummyMalcolmDevice

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.malcolm.core.AbstractMalcolmDevice

org.eclipse.scanning.example.malcolm.DummyMalcolmDevice

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 DummyMalcolmDevice
extends AbstractMalcolmDevice

A dummy Malcolm device for use in dummy mode or tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DummyMalcolmDevice.DummyMalcolmControlledDevice	Abstract superclass for a dummy malcolm controlled device which writes nexus.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATASET_NAME_UNIQUE_KEYS
static final String	FILE_EXTENSION_HDF5
static final String	UNIQUE_KEYS_DATASET_PATH

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

Method Summary

Modifier and Type	Method	Description
void	configure(IMalcolmModel model)	Call to configure the device.
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.
DeviceState	getDeviceState()
DummyMalcolmModel	getModel()	The model being used for the device.
MalcolmVersion	getVersion()	Returns the version of this malcolm device.
void	initialize()	Initializes the connection to the actual malcolm device.
boolean	isLocked()	Attempts to determine if the device is locked doing something like a configure or a run.
void	pause()	Allowed when the device is in Running state.
void	resume()	Allowed when the device is in Paused state.
void	run(IPosition outerScanPosition)	Blocking call to execute the scan.
void	scanFinally()
<T> void	setAttributeValue(String attributeName, T value)
void	setAvailableAxes(List<String> availableAxes)
protected void	setDeviceState(DeviceState nstate)
void	setFlattenGridScan(boolean flattenGridScan)
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.
void	setPrependScanName(boolean prependScanName)
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, sendEvent, setTemplateBean, start

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

abort, addRunListener, disable, fireRunPerformed, fireRunWillPerform, fireStateChanged, fireWritePerformed, fireWriteWillPerform, getConfigureTime, getConnectorService, getDeviceHealth, getDeviceInformation, getLevel, getPublisher, getRole, getRunnableDeviceService, getScanAttribute, getScanAttributeNames, getScanId, getSupportedScanModes, isActivated, isAlive, isDeviceBusy, removeRunListener, reset, seek, setActivated, setAlive, setBusy, setConfigureTime, setConnectorService, setDeviceInformation, 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.IPausableDevice

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, isAlive, isDeviceBusy, 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

DATASET_NAME_UNIQUE_KEYS

public static final String DATASET_NAME_UNIQUE_KEYS

See Also:

• Constant Field Values

UNIQUE_KEYS_DATASET_PATH

public static final String UNIQUE_KEYS_DATASET_PATH

See Also:

• Constant Field Values

FILE_EXTENSION_HDF5

public static final String FILE_EXTENSION_HDF5

See Also:

• Constant Field Values

Constructor Details

DummyMalcolmDevice

public DummyMalcolmDevice()

Method Details

setPrependScanName

public void setPrependScanName(boolean prependScanName)

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

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

scanFinally

public void scanFinally()
                 throws ScanningException

Overrides:

scanFinally in class AbstractMalcolmDevice

Throws:

ScanningException

setDeviceState

protected void setDeviceState(DeviceState nstate)

Overrides:

setDeviceState in class AbstractRunnableDevice<IMalcolmModel>

Parameters:

nstate -

getDeviceState

public DeviceState getDeviceState()
                           throws ScanningException

Specified by:

getDeviceState in interface IRunnableDevice<IMalcolmModel>

Overrides:

getDeviceState in class AbstractRunnableDevice<IMalcolmModel>

Returns:

the current device State. This is not the same as the Status of the scan.

Throws:

ScanningException

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

Overrides:

setOutputDir in class AbstractMalcolmDevice

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

Overrides:

setPointGenerator in class AbstractMalcolmDevice

Parameters:

pointGenerator - point generator

getModel

public DummyMalcolmModel 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:

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

run

public void run(IPosition outerScanPosition)
         throws ScanningException,
InterruptedException

Description copied from interface: IRunnableDevice

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

Throws:

ScanningException

InterruptedException

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

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

setAttributeValue

public <T> void setAttributeValue(String attributeName,
 T value)
                           throws ScanningException

Throws:

ScanningException

pause

public void pause()
           throws ScanningException

Description copied from interface: IPausableDevice

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

Specified by:

pause in interface IPausableDevice<IMalcolmModel>

Overrides:

pause in class AbstractRunnableDevice<IMalcolmModel>

Throws:

ScanningException

resume

public void resume()
            throws ScanningException

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:

ScanningException

getAvailableAxes

public List<String> getAvailableAxes()
                              throws ScanningException

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:

ScanningException

setAvailableAxes

public void setAvailableAxes(List<String> availableAxes)

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

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

getDetectorInfos

public List<MalcolmDetectorInfo> getDetectorInfos()
                                           throws MalcolmDeviceException

Description copied from interface: IMalcolmDevice

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

Returns:

detector infos

Throws:

MalcolmDeviceException

setFlattenGridScan

public void setFlattenGridScan(boolean flattenGridScan)