Package org.eclipse.scanning.api.scan.models

Class ScanModel

java.lang.Object

org.eclipse.scanning.api.scan.models.ScanModel

public class ScanModel
extends Object

A Model describing a scan to be performed.

Constructor Summary

Constructors

Constructor	Description
ScanModel()
ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator)
ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator, File file)
ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator, IRunnableDevice<? extends IDetectorModel> detector)

Method Summary

Modifier and Type	Method	Description
void	addScanMetadata(ScanMetadata scanMetadata)
boolean	equals(Object obj)
List<?>	getAdditionalScanObjects()
ScanBean	getBean()
List<IRunnableDevice<? extends IDetectorModel>>	getDetectors()
String	getFilePath()
List<IScannable<?>>	getMonitorsPerPoint()
List<IScannable<?>>	getMonitorsPerScan()
IPointGenerator<? extends IScanPointGeneratorModel>	getPointGenerator()
ScanInformation	getScanInformation()
List<ScanMetadata>	getScanMetadata()
List<IScannable<?>>	getScannables()
IScanPointGeneratorModel	getScanPathModel()
Set<String>	getTemplateFilePaths()
int	hashCode()
boolean	isMalcolmScan()
void	setAdditionalScanObjects(List<?> scanObjects)
void	setBean(ScanBean bean)
void	setDetector(IRunnableDevice<? extends IDetectorModel> detector)
void	setDetectors(List<IRunnableDevice<? extends IDetectorModel>> ds)
void	setFilePath(String filePath)
void	setMonitorsPerPoint(List<IScannable<?>> monitors)
void	setMonitorsPerPoint(IScannable<?>... monitors)
void	setMonitorsPerScan(List<IScannable<?>> monitors)
void	setMonitorsPerScan(IScannable<?>... monitors)
void	setPointGenerator(IPointGenerator<? extends IScanPointGeneratorModel> pointGenerator)
void	setScanInformation(ScanInformation scanInformation)
void	setScanMetadata(List<ScanMetadata> scanMetadata)
void	setScannables(List<IScannable<?>> scannables)
void	setScanPathModel(IScanPointGeneratorModel scanPathModel)
void	setTemplateFilePaths(Set<String> templateFilePaths)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScanModel

public ScanModel()

ScanModel

public ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator)

ScanModel

public ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator,
 IRunnableDevice<? extends IDetectorModel> detector)

ScanModel

public ScanModel(IPointGenerator<? extends IScanPointGeneratorModel> positionIterator,
 File file)

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBean

public ScanBean getBean()

setBean

public void setBean(ScanBean bean)

getScanPathModel

public IScanPointGeneratorModel getScanPathModel()

setScanPathModel

public void setScanPathModel(IScanPointGeneratorModel scanPathModel)

getPointGenerator

public IPointGenerator<? extends IScanPointGeneratorModel> getPointGenerator()

setPointGenerator

public void setPointGenerator(IPointGenerator<? extends IScanPointGeneratorModel> pointGenerator)

getScannables

public List<IScannable<?>> getScannables()

setScannables

public void setScannables(List<IScannable<?>> scannables)

getDetectors

public List<IRunnableDevice<? extends IDetectorModel>> getDetectors()

setDetectors

public void setDetectors(List<IRunnableDevice<? extends IDetectorModel>> ds)

setDetector

public void setDetector(IRunnableDevice<? extends IDetectorModel> detector)

getMonitorsPerPoint

public List<IScannable<?>> getMonitorsPerPoint()

setMonitorsPerPoint

public void setMonitorsPerPoint(List<IScannable<?>> monitors)

setMonitorsPerPoint

public void setMonitorsPerPoint(IScannable<?>... monitors)

getMonitorsPerScan

public List<IScannable<?>> getMonitorsPerScan()

setMonitorsPerScan

public void setMonitorsPerScan(List<IScannable<?>> monitors)

setMonitorsPerScan

public void setMonitorsPerScan(IScannable<?>... monitors)

getFilePath

public String getFilePath()

setFilePath

public void setFilePath(String filePath)

getTemplateFilePaths

public Set<String> getTemplateFilePaths()

setTemplateFilePaths

public void setTemplateFilePaths(Set<String> templateFilePaths)

getScanMetadata

public List<ScanMetadata> getScanMetadata()

setScanMetadata

public void setScanMetadata(List<ScanMetadata> scanMetadata)

addScanMetadata

public void addScanMetadata(ScanMetadata scanMetadata)

getAdditionalScanObjects

public List<?> getAdditionalScanObjects()

setAdditionalScanObjects

public void setAdditionalScanObjects(List<?> scanObjects)

getScanInformation

public ScanInformation getScanInformation()

setScanInformation

public void setScanInformation(ScanInformation scanInformation)

isMalcolmScan

public boolean isMalcolmScan()

toString

public String toString()

Overrides:

toString in class Object