Package org.eclipse.scanning.api.points.models

Class ScanRegion

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.points.models.ScanRegion

Type Parameters:

T -

All Implemented Interfaces:

INameable

public class ScanRegion
extends AbstractNameable

A scan region encapsulates a geometric region of interest with the names of the scan axes over which it is a region. If the ScanRegion contains no ROI, it is treated as a SquashingExcluder, collapsing all dimensions that contain at least one of its axis into a single Dimension.

Constructor Summary

Constructors

Constructor	Description
ScanRegion()
ScanRegion(String name)
ScanRegion(String name, Object type, List<String> snames)
ScanRegion(String name, List<String> axes)
ScanRegion(IROI roi, String... names)
ScanRegion(IROI roi, List<String> names)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
IROI	getRoi()
List<String>	getScannables()
Object	getType()
int	hashCode()
void	setRoi(IROI roi)
void	setScannables(List<String> scannables)
void	setType(Object type)
String	toString()

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Details

ScanRegion

public ScanRegion()

ScanRegion

public ScanRegion(String name)

ScanRegion

public ScanRegion(String name,
 Object type,
 List<String> snames)

ScanRegion

public ScanRegion(String name,
 List<String> axes)

ScanRegion

public ScanRegion(IROI roi,
 List<String> names)

ScanRegion

public ScanRegion(IROI roi,
 String... names)

Method Details

getRoi

public IROI getRoi()

setRoi

public void setRoi(IROI roi)

getScannables

public List<String> getScannables()

setScannables

public void setScannables(List<String> scannables)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNameable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractNameable

getType

public Object getType()

setType

public void setType(Object type)

toString

public String toString()

Overrides:

toString in class AbstractNameable