Package org.eclipse.scanning.sequencer
Class AbstractRunnableDeviceDelegate
java.lang.Object
org.eclipse.scanning.sequencer.AbstractRunnableDeviceDelegate
This class is the abstract base class of all classes which define the delegated functionality of an
RunnableDeviceProxy object.
Since this defines all functions through inheritance rather than through annotations, and it doesn't depend on interface default methods, it can be used as a base class for delegates defined in Jython.
Note that an object of this class must be initialised with a reference to the object it is going to provide delegated functionality to and setDelegate() on that object should then be immediately called with this one.
Example of use:
runnableDeviceProxyFinder = finder.find("runnableDeviceProxyFinder")
runnableDeviceProxy = runnableDeviceProxyFinder.getRunnableDevice()
from jythonRunnableDeviceDelegate import JythonRunnableDeviceDelegate
jythonRunnableDeviceDelegate = JythonRunnableDeviceDelegate(runnableDeviceProxy)
runnableDeviceProxy.setDelegate(jythonRunnableDeviceDelegate)
runnableDeviceProxy.register()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidprotected NexusObjectWrapper<NXobject> getNexusObjectWrapper(String name, NXobject nexusBaseClass) voidlevelEnd(LevelInformation info) voidlevelStart(LevelInformation info) voidvoidpointStart(IPosition point) voidpostConfigure(ScanModel scanModel, ScanBean scanBean, IPublisher<?> publisher) voidpreConfigure(ScanModel scanModel, ScanBean scanBean, IPublisher<?> publisher) voidvoidscanAbort(ScanInformation info) voidscanEnd(ScanInformation info) voidscanFault(ScanInformation info) voidscanFinally(ScanInformation info) voidvoidvoidscanStart(ScanInformation info) booleanvoidwriteComplete(ScanInformation info) DelegatedWriteComplete
-
Constructor Details
-
AbstractRunnableDeviceDelegate
-
-
Method Details
-
getRunnableDeviceProxy
-
configure
- Throws:
ScanningException
-
run
-
write
- Throws:
ScanningException
-
getNexusProvider
- Throws:
NexusException
-
getNexusProviders
-
getNexusObjectWrapper
-
preConfigure
public void preConfigure(ScanModel scanModel, ScanBean scanBean, IPublisher<?> publisher) throws ScanningException - Throws:
ScanningException
-
postConfigure
public void postConfigure(ScanModel scanModel, ScanBean scanBean, IPublisher<?> publisher) throws ScanningException - Throws:
ScanningException
-
levelStart
- Throws:
ScanningException
-
levelEnd
- Throws:
ScanningException
-
pointStart
- Throws:
ScanningException
-
pointEnd
- Throws:
ScanningException
-
scanStart
- Throws:
ScanningException
-
scanEnd
- Throws:
ScanningException
-
writeComplete
DelegatedWriteComplete- Parameters:
info-- Throws:
ScanningException
-
scanAbort
- Throws:
ScanningException
-
scanFault
- Throws:
ScanningException
-
scanFinally
- Throws:
ScanningException
-
scanPause
- Throws:
ScanningException
-
scanResume
- Throws:
ScanningException
-