Package org.eclipse.scanning.sequencer

Class RunnableDeviceProxy<T>

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.sequencer.RunnableDeviceProxy<T>

All Implemented Interfaces:

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

public class RunnableDeviceProxy<T>
extends AbstractRunnableDevice<T>
implements INexusDevice<NXobject>

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

Method Summary

Modifier and Type	Method	Description
void	configure(Object model)	Call to configure the device.
AbstractRunnableDeviceDelegate	getDelegate()
NexusObjectProvider<NXobject>	getNexusProvider(NexusScanInfo info)	Returns the object provider required for writing correct NeXus files.
List<NexusObjectProvider<NXobject>>	getNexusProviders(NexusScanInfo info)	Returns the object providers required for writing correct NeXus files.
void	levelEnd(LevelInformation info)
void	levelStart(LevelInformation info)
void	pointEnd(IPosition point)
void	pointStart(IPosition point)
void	postConfigure(ScanModel model, ScanBean scanBean, IPublisher<?> publisher)
void	preConfigure(ScanModel model, ScanBean scanBean, IPublisher<?> publisher)
void	run(IPosition position)	Blocking call to execute the scan.
void	scanAbort(ScanInformation info)
void	scanEnd(ScanInformation info)
void	scanFault(ScanInformation info)
void	scanFinally(ScanInformation info)
void	scanPaused()
void	scanResumed()
void	scanStart(ScanInformation info)
void	setDelegate(AbstractRunnableDeviceDelegate delegate)
void	setDeviceState(DeviceState nstate)	Allow delegates to set the device state.
void	writeComplete(ScanInformation info)

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, reset, resume, seek, setActivated, setAlive, setBusy, setConfigureTime, setConnectorService, setDeviceInformation, 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.IModelProvider

updateModel

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

getName, setName

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

getCustomNexusModification, getName, register

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

latch, latch, run, start, throwFirstRunException

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

setService

Constructor Details

RunnableDeviceProxy

public RunnableDeviceProxy()

Method Details

configure

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

Overrides:

configure in class AbstractRunnableDevice<T>

Parameters:

model -

Throws:

ScanningException

setDeviceState

public void setDeviceState(DeviceState nstate)
                    throws ScanningException

Allow delegates to set the device state.

Overrides:

setDeviceState in class AbstractRunnableDevice<T>

Parameters:

nstate - New State

Throws:

ScanningException

run

public void run(IPosition position)
         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<T>

Throws:

ScanningException

InterruptedException

getNexusProvider

public NexusObjectProvider<NXobject> 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<T>

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

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

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

preConfigure

public void preConfigure(ScanModel model,
 ScanBean scanBean,
 IPublisher<?> publisher)
                  throws ScanningException

Throws:

ScanningException

postConfigure

public void postConfigure(ScanModel model,
 ScanBean scanBean,
 IPublisher<?> publisher)
                   throws ScanningException

Throws:

ScanningException

levelStart

public void levelStart(LevelInformation info)
                throws ScanningException

Throws:

ScanningException

levelEnd

public void levelEnd(LevelInformation info)
              throws ScanningException

Throws:

ScanningException

pointStart

public void pointStart(IPosition point)
                throws ScanningException

Throws:

ScanningException

pointEnd

public void pointEnd(IPosition point)
              throws ScanningException

Throws:

ScanningException

scanStart

public void scanStart(ScanInformation info)
               throws ScanningException

Throws:

ScanningException

scanEnd

public void scanEnd(ScanInformation info)
             throws ScanningException

Throws:

ScanningException

writeComplete

public void writeComplete(ScanInformation info)
                   throws ScanningException

Throws:

ScanningException

scanAbort

public void scanAbort(ScanInformation info)
               throws ScanningException

Throws:

ScanningException

scanFault

public void scanFault(ScanInformation info)
               throws ScanningException

Throws:

ScanningException

scanFinally

public void scanFinally(ScanInformation info)
                 throws ScanningException

Throws:

ScanningException

scanPaused

public void scanPaused()
                throws ScanningException

Throws:

ScanningException

scanResumed

public void scanResumed()
                 throws ScanningException

Throws:

ScanningException

getDelegate

public AbstractRunnableDeviceDelegate getDelegate()

setDelegate

public void setDelegate(AbstractRunnableDeviceDelegate delegate)