Package uk.ac.gda.client.live.stream.handlers

Class LiveStreamPlottable

java.lang.Object

uk.ac.gda.client.live.stream.handlers.LiveStreamPlottable

All Implemented Interfaces:

LiveStreamMapObject, MapObject, PlottableMapObject

public class LiveStreamPlottable
extends Object
implements LiveStreamMapObject

A class that wraps a LiveStreamConnection and implements LiveStreamMapObject so that a live stream can be plotted in the map view.

Nested Class Summary

Nested classes/interfaces inherited from interface org.dawnsci.mapping.ui.datamodel.LiveStreamMapObject

LiveStreamMapObject.IAxisMoveListener

Constructor Summary

Constructors

Constructor	Description
LiveStreamPlottable(LiveStreamConnection connection)

Method Summary

Modifier and Type	Method	Description
void	addAxisListener(LiveStreamMapObject.IAxisMoveListener listener)
void	connect()
void	disconnect()
List<org.eclipse.january.dataset.IDataset>	getAxes()
Object[]	getChildren()
double[]	getColorRange()	Get the color range
org.eclipse.january.dataset.IDynamicShape	getDynamicDataset()
String	getLongName()	Gets the (unique) long name for the object
org.eclipse.january.dataset.IDataset	getMap()	Gets the plottable data
String	getPath()	Get the path to the file
double[]	getRange()
org.eclipse.january.dataset.IDataset	getSpectrum(double x, double y)	Get the slice of the parent data that corresponds to the specified x,y position
int	getTransparency()	Get the transparency value for the map
boolean	hasChildren()
boolean	isLive()	Returns whether this data is from a live scan
boolean	isPlotted()	Return true if the object is plotted
void	removeAxisListener(LiveStreamMapObject.IAxisMoveListener listener)
void	setColorRange(double[] range)	Set the color range for the map
void	setPlotted(boolean plotted)	Set whether the object should be plotted or not
void	setTransparency(int transparency)	Set the transparency value for the map
void	update()	Call to update the internal data from file.

Methods inherited from class java.lang.Object

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

Constructor Details

LiveStreamPlottable

public LiveStreamPlottable(LiveStreamConnection connection)

Method Details

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface MapObject

getChildren

public Object[] getChildren()

Specified by:

getChildren in interface MapObject

getRange

public double[] getRange()

Specified by:

getRange in interface MapObject

getLongName

public String getLongName()

Description copied from interface: PlottableMapObject

Gets the (unique) long name for the object

Specified by:

getLongName in interface PlottableMapObject

Returns:

longName

getMap

public org.eclipse.january.dataset.IDataset getMap()

Description copied from interface: PlottableMapObject

Gets the plottable data

Specified by:

getMap in interface PlottableMapObject

Returns:

map

isLive

public boolean isLive()

Description copied from interface: PlottableMapObject

Returns whether this data is from a live scan

Specified by:

isLive in interface PlottableMapObject

Returns:

update

public void update()

Description copied from interface: PlottableMapObject

Call to update the internal data from file.

For live files when the map size is increasing

Specified by:

update in interface PlottableMapObject

getTransparency

public int getTransparency()

Description copied from interface: PlottableMapObject

Get the transparency value for the map

Specified by:

getTransparency in interface PlottableMapObject

Returns:

getSpectrum

public org.eclipse.january.dataset.IDataset getSpectrum(double x,
 double y)

Description copied from interface: PlottableMapObject

Get the slice of the parent data that corresponds to the specified x,y position

Specified by:

getSpectrum in interface PlottableMapObject

Parameters:

x -

y -

Returns:

data

getPath

public String getPath()

Description copied from interface: PlottableMapObject

Get the path to the file

Specified by:

getPath in interface PlottableMapObject

Returns:

isPlotted

public boolean isPlotted()

Description copied from interface: PlottableMapObject

Return true if the object is plotted

Specified by:

isPlotted in interface PlottableMapObject

Returns:

setPlotted

public void setPlotted(boolean plotted)

Description copied from interface: PlottableMapObject

Set whether the object should be plotted or not

Specified by:

setPlotted in interface PlottableMapObject

Parameters:

plotted -

getAxes

public List<org.eclipse.january.dataset.IDataset> getAxes()

Specified by:

getAxes in interface LiveStreamMapObject

connect

public void connect()
             throws LiveStreamException

Specified by:

connect in interface LiveStreamMapObject

Throws:

LiveStreamException

disconnect

public void disconnect()
                throws LiveStreamException

Specified by:

disconnect in interface LiveStreamMapObject

Throws:

LiveStreamException

addAxisListener

public void addAxisListener(LiveStreamMapObject.IAxisMoveListener listener)

Specified by:

addAxisListener in interface LiveStreamMapObject

removeAxisListener

public void removeAxisListener(LiveStreamMapObject.IAxisMoveListener listener)

Specified by:

removeAxisListener in interface LiveStreamMapObject

setColorRange

public void setColorRange(double[] range)

Description copied from interface: PlottableMapObject

Set the color range for the map

Specified by:

setColorRange in interface PlottableMapObject

Parameters:

range -

getColorRange

public double[] getColorRange()

Description copied from interface: PlottableMapObject

Get the color range

Specified by:

getColorRange in interface PlottableMapObject

Returns:

range

getDynamicDataset

public org.eclipse.january.dataset.IDynamicShape getDynamicDataset()

Specified by:

getDynamicDataset in interface LiveStreamMapObject

setTransparency

public void setTransparency(int transparency)

Description copied from interface: PlottableMapObject

Set the transparency value for the map

Specified by:

setTransparency in interface PlottableMapObject