Package org.eclipse.scanning.server.servlet

Class ScanProcess

java.lang.Object

org.eclipse.scanning.server.servlet.ScanProcess

All Implemented Interfaces:

IBeanProcess<ScanBean>, IPublishable<ScanBean>

public class ScanProcess
extends Object
implements IBeanProcess<ScanBean>

Object for running a scan. TODO: DAQ-1960 - make ScanProcess solely responsible for updating the ScanBean at present this is split between ScanProcess and AcquisitionDevice

Constructor Summary

Constructors

Constructor	Description
ScanProcess(ScanBean scanBean, IPublisher<ScanBean> response, boolean blocking)

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute the process, if an exception is thrown the process is set to failed and the message is the message of the exception.
ScanBean	getBean()
IPublisher<ScanBean>	getPublisher()
boolean	isPaused()	Returns whether the process is paused.
void	pause()	Call to pause the running process.
void	resume()	Call to resume the process.
void	terminate()	Please provide a termination for the process by implementing this method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.event.core.IBeanProcess

isBlocking, start

Constructor Details

ScanProcess

public ScanProcess(ScanBean scanBean,
 IPublisher<ScanBean> response,
 boolean blocking)
            throws EventException

Throws:

EventException

Method Details

pause

public void pause()
           throws EventException

Description copied from interface: IBeanProcess

Call to pause the running process.

Specified by:

pause in interface IBeanProcess<ScanBean>

Throws:

EventException

resume

public void resume()
            throws EventException

Description copied from interface: IBeanProcess

Call to resume the process.

Specified by:

resume in interface IBeanProcess<ScanBean>

Throws:

EventException

terminate

public void terminate()
               throws EventException

Description copied from interface: IBeanProcess

Please provide a termination for the process by implementing this method. If the process has a stop file, write it now; if it needs to be killed, get its pid and kill it; if it is running on a cluster, use the qdel or dramaa api.

Specified by:

terminate in interface IBeanProcess<ScanBean>

Throws:

EventException

execute

public void execute()
             throws EventException

Description copied from interface: IBeanProcess

Execute the process, if an exception is thrown the process is set to failed and the message is the message of the exception. This is the blocking method to run the process. The start method will be called by the IJobQueue's consumer thread running the process and by default terminate is called in the same thread.

Specified by:

execute in interface IBeanProcess<ScanBean>

Throws:

EventException

isPaused

public boolean isPaused()

Description copied from interface: IBeanProcess

Returns whether the process is paused. If using AbstractLockingPausableProcess, it will be automatically.

Specified by:

isPaused in interface IBeanProcess<ScanBean>

Returns:

true if the process is paused, false otherwise

getBean

public ScanBean getBean()

Specified by:

getBean in interface IPublishable<ScanBean>

Returns:

the bean which this process is currently running.

getPublisher

public IPublisher<ScanBean> getPublisher()

Specified by:

getPublisher in interface IPublishable<ScanBean>

Returns:

the bean which this process is currently running.