Package org.eclipse.scanning.example.detector

Class RandomLineDevice

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.example.detector.RandomLineDevice

All Implemented Interfaces:

INexusDevice<NXdetector>, IActivatable, IPausableDevice<RandomLineModel>, IResettableDevice, IRunnableDevice<RandomLineModel>, IRunnableEventDevice<RandomLineModel>, IWritableDetector<RandomLineModel>, IDeviceRoleActor, IConfigurable<RandomLineModel>, ILevel, IModelProvider<RandomLineModel>, INameable, IScanAttributeContainer, IValidator<RandomLineModel>

public class RandomLineDevice
extends AbstractRunnableDevice<RandomLineModel>
implements IWritableDetector<RandomLineModel>, INexusDevice<NXdetector>

This device mimicks telling EPICS to do a scan down a line. It writes an HDF5 file for the line (actually random data)

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	clean()
void	configure(RandomLineModel model)	Call to configure the device.
protected void	count(StackTraceElement[] ste)
protected void	count(StackTraceElement[] ste, Object value)
NXdetector	createNexusObject(NexusScanInfo info)
int	getCount(String method)
protected static final String	getMethodName(StackTraceElement[] ste)
NexusObjectProvider<NXdetector>	getNexusProvider(NexusScanInfo info)	Returns the object provider required for writing correct NeXus files.
Object	getValue(String method, int index)
boolean	isThrowWriteExceptions()
void	reset()	Allowed from Fault.
void	resetCount()
void	run(IPosition pos)	Blocking call to execute the scan.
void	setThrowWriteExceptions(boolean throwWriteExceptions)
boolean	write(IPosition pos)	For GDA9 detectors, returns a boolean for the readout completed, true for complete, false for error.

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

abort, addRunListener, disable, fireRunPerformed, fireRunWillPerform, fireStateChanged, fireWritePerformed, fireWriteWillPerform, getConfigureTime, getConnectorService, getDeviceHealth, getDeviceInformation, getDeviceInformation, getDeviceState, getLevel, getModel, getPublisher, getRole, getRunnableDeviceService, getScanAttribute, getScanAttributeNames, getScanId, getSupportedScanModes, isActivated, isAlive, isDeviceBusy, pause, register, removeRunListener, 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.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, getNexusProviders, register

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

pause, resume, seek

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

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

Constructor Details

RandomLineDevice

public RandomLineDevice()
                 throws ScanningException

Throws:

ScanningException

Method Details

clean

public void clean()

getNexusProvider

public NexusObjectProvider<NXdetector> getNexusProvider(NexusScanInfo info)
                                                 throws NexusException

Description copied from interface: INexusDevice

Returns the object provider required for writing correct NeXus files.

In this method you should prepare the LazyDatasets the device will fill during the scan. You can also write out static device metadata, which will not change during the scan.

Use the methods on NexusNodeFactory to create a NeXus object which matches the device e.g. a NXdetector. final NXdetector detector = NexusNodeFactory.createNXdetector();

On the detector object you can create LazyDatasets and keep references which you can later use during the scan to write data. e.g. imageData = detector.initializeLazyDataset(NXdetector.NX_DATA, info.getRank() + 2, Double.class); You should also set chunking on the LazyDatasets you create e.g. imageData.setChunking(info.createChunk(detectorXSize, detectorYSize));.

In this method you can also write static metadata such as the detector exposure e.g. detector.setField("exposure_time", model.getExposure());. Or static datasets such as the image axis data detector.setDataset("image_x_axis", DatasetFactory.createLinearSpace(DoubleDataset.class, minX, maxX, xPoints)); For fields that are defined in the NXDL base class definition for the returned nexus object, a setXXX or setXXXScalar method may be used as appropriate, e.g. detector.setLocalName(DatasetFactory.createFromObject("my detector")); or detector.setLocalNameScalar("my detector");

If this device is a 'metadata scannable', then the device should write its data at this point directly into the returned nexus object. This can be done with the NXobject.setField(String, Object) method, or the setXXXScalar methods for fields defined in the appropriate NXDL base class definition.

The default implementation of this method throws UnsupportedOperationException. 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:

getNexusProvider in interface INexusDevice<NXdetector>

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

createNexusObject

public NXdetector createNexusObject(NexusScanInfo info)
                             throws NexusException

Throws:

NexusException

configure

public void configure(RandomLineModel 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<RandomLineModel>

Overrides:

configure in class AbstractRunnableDevice<RandomLineModel>

Parameters:

model -

Throws:

ScanningException

run

public void run(IPosition pos)
         throws ScanningException,
InterruptedException

Description copied from interface: IRunnableDevice

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

Specified by:

run in interface IRunnableDevice<RandomLineModel>

Throws:

ScanningException

InterruptedException

write

public boolean write(IPosition pos)
              throws ScanningException,
InterruptedException

Description copied from interface: IWritableDetector

For GDA9 detectors, returns a boolean for the readout completed, true for complete, false for error. Generally detectors running in GDA9 will be IDetector. For GDA8 detectors, the readout will be overridden.

Specified by:

write in interface IWritableDetector<RandomLineModel>

Returns:

true for a successful readout. If false the events will not be fired and the scan will continue.

Throws:

ScanningException

InterruptedException

count

protected void count(StackTraceElement[] ste)
              throws ScanningException

Throws:

ScanningException

count

protected void count(StackTraceElement[] ste,
 Object value)
              throws ScanningException

Throws:

ScanningException

getCount

public int getCount(String method)

getValue

public Object getValue(String method,
 int index)

getMethodName

protected static final String getMethodName(StackTraceElement[] ste)

reset

public void reset()
           throws ScanningException

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<RandomLineModel>

Throws:

ScanningException

resetCount

public void resetCount()

isThrowWriteExceptions

public boolean isThrowWriteExceptions()

setThrowWriteExceptions

public void setThrowWriteExceptions(boolean throwWriteExceptions)