Package org.eclipse.scanning.api.scan

Class ScanInformation

java.lang.Object

org.eclipse.scanning.api.scan.ScanInformation

public class ScanInformation
extends Object

Holds state of whole scan. May be used in annotated methods like @ScanStart to provide information about whole scan. Should not be used to hold transient state during the scan. One should be created per run.

Constructor Summary

Constructors

Constructor	Description
ScanInformation(IPointGenerator<?> pointGen, Collection<IDetectorModel> detectorModels, String filePath)
ScanInformation(IPointGenerator<?> pointGen, ScanRequest scanRequest)
ScanInformation(IPointGeneratorService pointGenService, ScanRequest scanRequest)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
long	getEstimatedScanTime()
String	getFilePath()
int	getRank()
ScanMode	getScanMode()
List<String>	getScannableNames()
int[]	getShape()
int	getSize()
long	getTimePerPoint()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScanInformation

public ScanInformation(IPointGeneratorService pointGenService,
 ScanRequest scanRequest)
                throws GeneratorException

Throws:

GeneratorException

ScanInformation

public ScanInformation(IPointGenerator<?> pointGen,
 ScanRequest scanRequest)

ScanInformation

public ScanInformation(IPointGenerator<?> pointGen,
 Collection<IDetectorModel> detectorModels,
 String filePath)

Method Details

getScanMode

public ScanMode getScanMode()

getFilePath

public String getFilePath()

getSize

public int getSize()

getRank

public int getRank()

getScannableNames

public List<String> getScannableNames()

getShape

public int[] getShape()

getTimePerPoint

public long getTimePerPoint()

getEstimatedScanTime

public long getEstimatedScanTime()

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