Package org.eclipse.scanning.api.event.scan

Class ScanRequest

java.lang.Object

org.eclipse.scanning.api.event.scan.ScanRequest

All Implemented Interfaces:

Serializable

public class ScanRequest
extends Object
implements Serializable

A class to encapsulate minimal information required to run a scan.

For instance the JSON string of this class could be used on B23

The class automatically assigns a unique id for the run.

NB. A ScanRequest is passed to some beamline scripts (for example the I14 XANES script), so changes to the public methods should be kept to a minimum. If changes are made, the beamline should be informed.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScanRequest()
ScanRequest(IScanPointGeneratorModel m, IROI region, String filePath, List<String> monitorNamesPerPoint, List<String> monitorNamesPerScan)

Method Summary

Modifier and Type	Method	Description
void	addScanMetadata(ScanMetadata scanMetadata)
boolean	equals(Object obj)
ScriptRequest	getAfterScript()
ScriptRequest	getBeforeScript()
CompoundModel	getCompoundModel()
Map<String,IDetectorModel>	getDetectors()
IPosition	getEndPosition()
String	getFilePath()
Collection<String>	getMonitorNamesPerPoint()
Collection<String>	getMonitorNamesPerScan()
ProcessingRequest	getProcessingRequest()
List<ScanMetadata>	getScanMetadata()
IPosition	getStartPosition()
Set<String>	getTemplateFilePaths()
int	hashCode()
boolean	isAlwaysRunAfterScript()
boolean	isIgnorePreprocess()
void	putDetector(String name, IDetectorModel dmodel)
void	setAfterScript(ScriptRequest afterScript)
void	setAlwaysRunAfterScript(boolean alwaysRunAfterScript)
void	setBeforeScript(ScriptRequest before)
void	setCompoundModel(CompoundModel model)
void	setDetectors(Map<String,IDetectorModel> detectors)
void	setEnd(IPosition endPosition)
void	setFilePath(String filePath)
void	setIgnorePreprocess(boolean ignorePreprocess)
void	setMonitorNamesPerPoint(Collection<String> monitorNames)
void	setMonitorNamesPerScan(Collection<String> monitorNames)
void	setProcessingRequest(ProcessingRequest processingRequest)
void	setScanMetadata(List<ScanMetadata> scanMetadata)
void	setStartPosition(IPosition startPosition)
void	setTemplateFilePaths(Set<String> templateFilePaths)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScanRequest

public ScanRequest()

ScanRequest

public ScanRequest(IScanPointGeneratorModel m,
 IROI region,
 String filePath,
 List<String> monitorNamesPerPoint,
 List<String> monitorNamesPerScan)

Method Details

getProcessingRequest

public ProcessingRequest getProcessingRequest()

setProcessingRequest

public void setProcessingRequest(ProcessingRequest processingRequest)

getMonitorNamesPerPoint

public Collection<String> getMonitorNamesPerPoint()

setMonitorNamesPerPoint

public void setMonitorNamesPerPoint(Collection<String> monitorNames)

getMonitorNamesPerScan

public Collection<String> getMonitorNamesPerScan()

setMonitorNamesPerScan

public void setMonitorNamesPerScan(Collection<String> monitorNames)

getFilePath

public String getFilePath()

setFilePath

public void setFilePath(String filePath)

getTemplateFilePaths

public Set<String> getTemplateFilePaths()

setTemplateFilePaths

public void setTemplateFilePaths(Set<String> templateFilePaths)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getDetectors

public Map<String,IDetectorModel> getDetectors()

setDetectors

public void setDetectors(Map<String,IDetectorModel> detectors)

putDetector

public void putDetector(String name,
 IDetectorModel dmodel)

getStartPosition

public IPosition getStartPosition()

setStartPosition

public void setStartPosition(IPosition startPosition)

getEndPosition

public IPosition getEndPosition()

setEnd

public void setEnd(IPosition endPosition)

isIgnorePreprocess

public boolean isIgnorePreprocess()

setIgnorePreprocess

public void setIgnorePreprocess(boolean ignorePreprocess)

getBeforeScript

public ScriptRequest getBeforeScript()

setBeforeScript

public void setBeforeScript(ScriptRequest before)

getAfterScript

public ScriptRequest getAfterScript()

setAfterScript

public void setAfterScript(ScriptRequest afterScript)

getScanMetadata

public List<ScanMetadata> getScanMetadata()

setScanMetadata

public void setScanMetadata(List<ScanMetadata> scanMetadata)

addScanMetadata

public void addScanMetadata(ScanMetadata scanMetadata)

getCompoundModel

public CompoundModel getCompoundModel()

setCompoundModel

public void setCompoundModel(CompoundModel model)

isAlwaysRunAfterScript

public boolean isAlwaysRunAfterScript()

setAlwaysRunAfterScript

public void setAlwaysRunAfterScript(boolean alwaysRunAfterScript)