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

Class ScanBean

java.lang.Object

org.eclipse.scanning.api.event.IdBean

org.eclipse.scanning.api.event.status.StatusBean

org.eclipse.scanning.api.event.scan.ScanBean

All Implemented Interfaces:

Serializable

public final class ScanBean
extends StatusBean

This bean is used to disseminate messages about what has happened to the scan while it is being written.

Do not extend this class to allow arbitrary information to be sent. The event encapsulated by this bean should be sending just the information defined here, metadata that cannot circumvent the nexus file.

For instance adding a dynamic set of information, a map perhaps, would allow information which should be saved in the Nexus file to circumvent the file and be set in the event. It was decided in various meetings that doing this could mean that some data is not recorded as it should be in nexus. Therefore these events are simply designed to contain events not data. They are not the same as the old ScanDataPoint system in GDA

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final long	INVALID_ID

Fields inherited from class org.eclipse.scanning.api.event.status.StatusBean

EMPTY, estimatedTime, hostName, message, name, percentComplete, previousStatus, startTime, status, submissionTime, userName

Constructor Summary

Constructors

Constructor	Description
ScanBean()
ScanBean(ScanBean scanBean)
ScanBean(ScanRequest req)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getBeamline()
String	getExperimentId()
String	getFilePath()
long	getMappingBeanId()
int	getPoint()
IPosition	getPosition()
int	getScanNumber()
ScanRequest	getScanRequest()
int	getSize()	NOTE the size is the approximate size of the scan by using the iterators.
int	hashCode()
<T extends IdBean> void	merge(T with)	Subclasses must override this method calling super.merge(...)
void	putPosition(String name, int index, Object val)
boolean	scanEnd()
boolean	scanStart()
void	setBeamline(String beamline)
void	setExperimentId(String experimentId)
void	setFilePath(String filePath)
void	setMappingBeanId(long id)
void	setPoint(int frame)
void	setPosition(IPosition value)
void	setScanNumber(int scanNumber)
void	setScanRequest(ScanRequest scanRequest)
void	setSize(int size)	NOTE the size is the approximate size of the scan by using the iterators.
String	toProgressString()
String	toString()

Methods inherited from class org.eclipse.scanning.api.event.status.StatusBean

createName, getEstimatedTime, getHostName, getMessage, getName, getPercentComplete, getPreviousStatus, getProperties, getProperty, getRunDirectory, getStartTime, getStatus, getSubmissionTime, getUserName, setEstimatedTime, setHostName, setMessage, setName, setPercentComplete, setPreviousStatus, setProperties, setProperty, setRunDirectory, setStartTime, setStatus, setSubmissionTime, setUserName

Methods inherited from class org.eclipse.scanning.api.event.IdBean

getUniqueId, setUniqueId

Methods inherited from class java.lang.Object

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

Field Details

INVALID_ID

public static final long INVALID_ID

See Also:

• Constant Field Values

Constructor Details

ScanBean

public ScanBean()

ScanBean

public ScanBean(ScanRequest req)

ScanBean

public ScanBean(ScanBean scanBean)

Method Details

merge

public <T extends IdBean> void merge(T with)

Description copied from class: StatusBean

Subclasses must override this method calling super.merge(...)

Overrides:

merge in class StatusBean

Parameters:

with -

getFilePath

public String getFilePath()

setFilePath

public void setFilePath(String filePath)

getScanNumber

public int getScanNumber()

setScanNumber

public void setScanNumber(int scanNumber)

getBeamline

public String getBeamline()

setBeamline

public void setBeamline(String beamline)

toString

public String toString()

Overrides:

toString in class StatusBean

getExperimentId

public String getExperimentId()

setExperimentId

public void setExperimentId(String experimentId)

getPoint

public int getPoint()

setPoint

public void setPoint(int frame)

getSize

public int getSize()

NOTE the size is the approximate size of the scan by using the iterators. It is legal to do logic in an iterator - this means that the overall size is not constant for some custom scan types! However for the vast majority of linear scans size and shape are constant.

setSize

public void setSize(int size)

NOTE the size is the approximate size of the scan by using the iterators. It is legal to do logic in an iterator - this means that the overall size is not constant for some custom scan types! However for the vast majority of linear scans size and shape are constant.

Parameters:

size -

getPosition

public IPosition getPosition()

setPosition

public void setPosition(IPosition value)

putPosition

public void putPosition(String name,
 int index,
 Object val)

scanStart

public boolean scanStart()

Returns:

whether the scan has just started, i.e. transitioned from a Status.PREPARING state to a Status.RUNNING state.

scanEnd

public boolean scanEnd()

Returns:

whether the scan has just ended, i.e. transitioned from a RUNNING/RESUMED state to a post-running state.

getScanRequest

public ScanRequest getScanRequest()

setScanRequest

public void setScanRequest(ScanRequest scanRequest)

getMappingBeanId

public long getMappingBeanId()

setMappingBeanId

public void setMappingBeanId(long id)

toProgressString

public String toProgressString()

hashCode

public int hashCode()

Overrides:

hashCode in class StatusBean

equals

public boolean equals(Object obj)

Overrides:

equals in class StatusBean