Package uk.ac.diamond.daq.scanning

Class ScanHookParticipant

java.lang.Object

gda.factory.FindableBase

uk.ac.diamond.daq.scanning.ScanHookParticipant

All Implemented Interfaces:

Findable, IScanParticipant

public class ScanHookParticipant
extends FindableBase
implements IScanParticipant

Class that can be added as participant to ScanService. This has several annotated functions that call empty 'scan hook' functions with empty default implementations. These can be easily overridden in derived classes (e.g. in Jython).

Constructor Summary

Constructors

Constructor	Description
ScanHookParticipant()

Method Summary

Modifier and Type	Method	Description
void	addScanParticipant()
void	atFileDeclared(String fileName)
void	atPrepareForScan(ScanModel scanModel)
void	atScanEnd()
void	atScanFinally()
void	atScanStart()
void	fileDeclared(String filename)
void	prepareScan(ScanModel scanModel)
void	removeScanParticipant()
void	scanEnd()
void	scanFinally()
void	scanStart()
String	toString()

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScanHookParticipant

public ScanHookParticipant()

Method Details

addScanParticipant

public void addScanParticipant()

removeScanParticipant

public void removeScanParticipant()

prepareScan

public void prepareScan(ScanModel scanModel)

fileDeclared

public void fileDeclared(String filename)

scanStart

public void scanStart()

scanEnd

public void scanEnd()

scanFinally

public void scanFinally()

atPrepareForScan

public void atPrepareForScan(ScanModel scanModel)

atFileDeclared

public void atFileDeclared(String fileName)

atScanStart

public void atScanStart()

atScanEnd

public void atScanEnd()

atScanFinally

public void atScanFinally()

toString

public String toString()

Overrides:

toString in class Object