Package gda.device.detector.nxdetector.roi

Class PlotServerROISelectionProvider

java.lang.Object

gda.device.detector.nxdetector.roi.PlotServerROISelectionProvider

All Implemented Interfaces:

IndexedRectangularROIProvider<Integer>

public class PlotServerROISelectionProvider
extends Object
implements IndexedRectangularROIProvider<Integer>

Constructor Summary

Constructors

Constructor	Description
PlotServerROISelectionProvider()
PlotServerROISelectionProvider(String detectorName, int maximumActiveRois)

Method Summary

Modifier and Type	Method	Description
org.python.core.PyString	__str__()
List<RectangularROI<Integer>>	getActiveRoiList()	Returns a list of active Rois.
static String	getGuiName(String detectorName)
int	getMaximumActiveRois()
RectangularROI<Integer>	getRoi(int index)	Return a RectangularROI, or null if none is available/enabled.
List<RectangularROI>	getScisoftRoiListFromSDAPlotter()
String	getViewName()
void	setMaximumActiveRois(int maximumActiveRois)
void	setViewName(String viewName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlotServerROISelectionProvider

public PlotServerROISelectionProvider()

PlotServerROISelectionProvider

public PlotServerROISelectionProvider(String detectorName,
 int maximumActiveRois)

Method Details

getGuiName

public static String getGuiName(String detectorName)

getActiveRoiList

public List<RectangularROI<Integer>> getActiveRoiList()
                                               throws Exception

Returns a list of active Rois. This will have no more than maximumActiveRois elements.

Returns:

a list of active rois.

Throws:

Exception

getScisoftRoiListFromSDAPlotter

public List<RectangularROI> getScisoftRoiListFromSDAPlotter()
                                                     throws Exception

Throws:

Exception

getRoi

public RectangularROI<Integer> getRoi(int index)
                               throws IndexOutOfBoundsException,
Exception

Description copied from interface: IndexedRectangularROIProvider

Return a RectangularROI, or null if none is available/enabled.

Specified by:

getRoi in interface IndexedRectangularROIProvider<Integer>

Parameters:

index - starting from 0

Returns:

an roi or null if none available/active

Throws:

IndexOutOfBoundsException

Exception - If the RCPPlotter.getBean throws an exception

__str__

public org.python.core.PyString __str__()

getMaximumActiveRois

public int getMaximumActiveRois()

setMaximumActiveRois

public void setMaximumActiveRois(int maximumActiveRois)

getViewName

public String getViewName()

setViewName

public void setViewName(String viewName)