Package gda.scan

Class ScanDataPointCache

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.scan.DataPointCache

gda.scan.ScanDataPointCache

All Implemented Interfaces:

Configurable, Findable, IScanDataPointObserver, gda.observable.IObserver

public class ScanDataPointCache
extends DataPointCache

This is a class designed to cache all the data from scan data points. It allows very quick retrieval of basic scan data for use in Jython or by scan processing.

Note: this class stores values as returned by IScanDataPoint.getAllValuesAsDoubles(), which attempts to convert all values to a Double. Any value that cannot be converted to a Double is replaced with null.

Constructor Summary

Constructors

Constructor	Description
ScanDataPointCache()

Method Summary

Modifier and Type	Method	Description
protected void	addDataPoint(IScanDataPoint sdp)	Add a IScanDataPoint to this cache.
List<Double>	getPositionsFor(String scannableName)	Extract a list of values for the given field name from the cached data.
protected void	initialise(IScanDataPoint sdp)	Run any initialisation required at the start of a scan.

Methods inherited from class gda.scan.DataPointCache

configure, update

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Constructor Details

ScanDataPointCache

public ScanDataPointCache()

Method Details

addDataPoint

protected void addDataPoint(IScanDataPoint sdp)

Description copied from class: DataPointCache

Add a IScanDataPoint to this cache. This will be called whenever a data point is produced by the IScanDataPointProvider this is observing.

Specified by:

addDataPoint in class DataPointCache

Parameters:

sdp - The new IScanDataPoint to cache

initialise

protected void initialise(IScanDataPoint sdp)

Description copied from class: DataPointCache

Run any initialisation required at the start of a scan. This will be called with the first point (where the currentPointNumber == 0) of each scan.

Overrides:

initialise in class DataPointCache

Parameters:

sdp - The first IScanDataPoint of the scan

getPositionsFor

public List<Double> getPositionsFor(String scannableName)

Description copied from class: DataPointCache

Extract a list of values for the given field name from the cached data.

Specified by:

getPositionsFor in class DataPointCache

Parameters:

scannableName - The field name for which to extract data

Returns:

A list of positions for the given field