Package gda.scan

Class MultithreadedScanDataPointPipeline

java.lang.Object

gda.scan.MultithreadedScanDataPointPipeline

All Implemented Interfaces:

ScanDataPointPipeline

public class MultithreadedScanDataPointPipeline
extends Object
implements ScanDataPointPipeline

An implementation of ScanDataPointPipeline that computes ScanDataPoints and broadcasts them using internally managed threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MultithreadedScanDataPointPipeline.NamedThreadFactory
class	MultithreadedScanDataPointPipeline.ScannableSpecificExecutorService

Constructor Summary

Constructors

Constructor	Description
MultithreadedScanDataPointPipeline(ScanDataPointPublisher broadcaster, int positionCallableThreadPoolSize, int scanDataPointPipelineLength, String scanName)	Creates a new MultithreadedScanDataPointPipeline and starts it up to accept points.

Method Summary

Modifier and Type	Method	Description
void	checkForException()	Throws exception if an exception occurred in the processing of the pipeline The main Scan thread can check this regularly
protected ScanDataPointPublisher	getBroadcaster()
DataWriter	getDataWriter()	Retrieves the data writer from the pipeline.
void	put(IScanDataPoint point)	Computes ScanDataPoints and broadcasts them using internally managed threads.
void	shutdown(boolean waitForProcessingCompletion)	Politely shutdown the pipeline.

Methods inherited from class java.lang.Object

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

Constructor Details

MultithreadedScanDataPointPipeline

public MultithreadedScanDataPointPipeline(ScanDataPointPublisher broadcaster,
 int positionCallableThreadPoolSize,
 int scanDataPointPipelineLength,
 String scanName)

Creates a new MultithreadedScanDataPointPipeline and starts it up to accept points.

Parameters:

broadcaster -

positionCallableThreadPoolSize - the number of threads used to process Callables

scanDataPointPipelineLength - the number of points allowed in the Pipeline concurrently.

Method Details

put

public void put(IScanDataPoint point)
         throws DeviceException

Computes ScanDataPoints and broadcasts them using internally managed threads.

Specified by:

put in interface ScanDataPointPipeline

Parameters:

point - scannablePositions or detectorData may contain Callables

Throws:

DeviceException

shutdown

public void shutdown(boolean waitForProcessingCompletion)
              throws Exception

Politely shutdown the pipeline. Blocks until processing is complete. Calls shutdownNow if there is any problem or if interrupted.

Specified by:

shutdown in interface ScanDataPointPipeline

Throws:

DeviceException

Exception

getDataWriter

public DataWriter getDataWriter()

Description copied from interface: ScanDataPointPipeline

Retrieves the data writer from the pipeline.

Specified by:

getDataWriter in interface ScanDataPointPipeline

Returns:

data writer

getBroadcaster

protected ScanDataPointPublisher getBroadcaster()

checkForException

public void checkForException()
                       throws Exception

Description copied from interface: ScanDataPointPipeline

Throws exception if an exception occurred in the processing of the pipeline The main Scan thread can check this regularly

Specified by:

checkForException in interface ScanDataPointPipeline

Throws:

Exception