XYWaveData (MDSplus jScope 7.138.0 API)

java.lang.Object
- mds.wave.XYWaveData

All Implemented Interfaces:

WaveData
```
public class XYWaveData
extends Object
implements WaveData
```
Author:

manduchi Basic version of WaveData which keeps arrays for X and Y (old style)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWaveDataListener(WaveDataListener listener)` Register a new WaveData listener.
`XYData`	`getData(double xmin, double xmax, int numPoints)` Get X and Y data for unidimensional signals within a given time interval The returned container object is an instance of XYData bringing information about X (time) and Y axis
`XYData`	`getData(int numPoints)` Get X and Y data for unidimensional signals The returned container object is an instance of XYData bringing information about X (time) and Y axis
`XYData`	`getData(long xmin, long xmax, int numPoints)` Get X and Y data for unidimensional signals within a given time interval expressed in absolute times The returned container object is an instance of XYData bringing information about X (time) and Y axis
`void`	`getDataAsync(double lowerBound, double upperBound, int numPoints)` Start asynchronous data readout.
`int`	`getNumDimension()` Returns the number of dimensions of the corresponding signal.
`String`	`GetTitle()` Get the title associated with that signal.
`double[]`	`getX2D()` Get X data for bidimensional signals.
`long[]`	`getX2DLong()` Get X data for bidimensional signals in absolute time units.
`String`	`GetXLabel()` Get the associated label for X axis.
`double[]`	`getXLimits()`
`long[]`	`getXLong()`
`float[]`	`getY2D()` Get Y data for bidimensional signals.
`String`	`GetYLabel()` Get the associated label for Y axis.
`float[]`	`getZ()` Get Z data for bidimensional signals.
`String`	`GetZLabel()` Get the associated label for Z axis (for bidimensional signals only).
`boolean`	`isXLong()` Check if absolute or relative times are used.
`void`	`removeWaveDataListener(WaveDataListener listener)` Unregister a WaveData listener.
`boolean`	`supportsStreaming()` Check whether this data supports streaming

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addWaveDataListener
```
public void addWaveDataListener(WaveDataListener listener)
```
    Description copied from interface: WaveData
    
    Register a new WaveData listener. jScope defines a publish-subscribe pattern to handle dynamic data visualization. Whenever new data are available for visualization, the DataProvider instance will notify the registered listeners via WaveDataListener.dataRegionUpdated() methods (two methods are defined format for handling absolute or relative times, respectively). DataProvider implementations that do not handle dynamic data display will implement this method as void.
    
    Specified by:
    
    addWaveDataListener in interface WaveData
    
    See Also:
    
    WaveDataListener
  - getData
```
public XYData getData(double xmin,
                      double xmax,
                      int numPoints)
```
    Description copied from interface: WaveData
    
    Get X and Y data for unidimensional signals within a given time interval The returned container object is an instance of XYData bringing information about X (time) and Y axis
    
    Specified by:
    
    getData in interface WaveData
    
    Returns:
    
    The XYData instance describing X and Y values of the returned signal.
    
    See Also:
    
    XYData
  - getData
```
public XYData getData(int numPoints)
```
    Description copied from interface: WaveData
    
    Get X and Y data for unidimensional signals The returned container object is an instance of XYData bringing information about X (time) and Y axis
    
    Specified by:
    
    getData in interface WaveData
    
    Returns:
    
    The XYData instance describing X and Y values of the returned signal.
    
    See Also:
    
    XYData
  - getData
```
public XYData getData(long xmin,
                      long xmax,
                      int numPoints)
```
    Description copied from interface: WaveData
    
    Get X and Y data for unidimensional signals within a given time interval expressed in absolute times The returned container object is an instance of XYData bringing information about X (time) and Y axis
    
    Specified by:
    
    getData in interface WaveData
    
    Returns:
    
    The XYData instance describing X and Y values of the returned signal.
    
    See Also:
    
    XYData
  - getDataAsync
```
public void getDataAsync(double lowerBound,
                         double upperBound,
                         int numPoints)
```
    Description copied from interface: WaveData
    
    Start asynchronous data readout. Expected to return soon, being the data chunk communicated later by notifying the registered listeners DataProvider instances supporting neither dynamic resample (for data reduction) nor support for signals evolving over time will implement this method as void. In this case the full signal will be returned by getData() method. getDataAsynch will be called by jScope whenever the required resolution of a zoomed portion of signal is less then current resolution of the stored signal. The computation of the signal resolution if left to the DataProvider implementation that will communicate it to jScope either via the returned XYData object in method getData() or in the resolution argument of the WaveDataListener callback methods. If the DataProvider implementation does not handle dynamic resolution, it will return Double.MAX_VALUE in the resolution argument of the XYData constructor, this disabling further calls of method getDataAsync().
    
    Specified by:
    
    getDataAsync in interface WaveData
  - getNumDimension
```
public int getNumDimension()
```
    Description copied from interface: WaveData
    
    Returns the number of dimensions of the corresponding signal. Currently only unidimensional and bidimensional signals are supported by jScope.
    
    Specified by:
    
    getNumDimension in interface WaveData
    
    Returns:
    
    The number of dimension for the represented signal.
  - GetTitle
```
public String GetTitle()
```
    Description copied from interface: WaveData
    
    Get the title associated with that signal. It is displayed if no title is defined in the setup data definition.
    
    Specified by:
    
    GetTitle in interface WaveData
    
    Returns:
    
    The title string.
  - getX2D
```
public double[] getX2D()
```
    Description copied from interface: WaveData
    
    Get X data for bidimensional signals. Called when the returned number of dimensions is 2 The X values are assumed to represent the time values
    
    Specified by:
    
    getX2D in interface WaveData
    
    Returns:
    
    The unidimensional array of X values.
  - getX2DLong
```
public long[] getX2DLong()
```
    Description copied from interface: WaveData
    
    Get X data for bidimensional signals in absolute time units. Called when the returned number of dimensions is 2 and returned value of isXLong() is true The X values are assumed to represent the absolute time values
    
    Specified by:
    
    getX2DLong in interface WaveData
    
    Returns:
    
    The unidimensional array of X values.
  - GetXLabel
```
public String GetXLabel()
```
    Get the associated label for X axis. It is displayed if no X axis label is defined in the setup data definition.
    
    Specified by:
    
    GetXLabel in interface WaveData
    
    Returns:
    
    The X label string.
    
    Throws:
    
    IOException
  - getXLimits
```
public double[] getXLimits()
```
  - getXLong
```
public long[] getXLong()
```
  - getY2D
```
public float[] getY2D()
```
    Description copied from interface: WaveData
    
    Get Y data for bidimensional signals. Called when the returned number of dimensions is 2
    
    Specified by:
    
    getY2D in interface WaveData
    
    Returns:
    
    The unidimensional array of Y values.
  - GetYLabel
```
public String GetYLabel()
```
    Get the associated label for Y axis. It is displayed if no Y axis label is defined in the setup data definition.
    
    Specified by:
    
    GetYLabel in interface WaveData
    
    Returns:
    
    The Y label string.
    
    Throws:
    
    IOException
  - getZ
```
public float[] getZ()
```
    Description copied from interface: WaveData
    
    Get Z data for bidimensional signals. Called when the returned number of dimensions is 2
    
    Specified by:
    
    getZ in interface WaveData
    
    Returns:
    
    The bisimensional array of Z values (z=f(x,y)). Row first order is assumed.
  - GetZLabel
```
public String GetZLabel()
```
    Get the associated label for Z axis (for bidimensional signals only). It is displayed if no X axis label is defined in the setup data definition.
    
    Specified by:
    
    GetZLabel in interface WaveData
    
    Returns:
    
    The Z label string.
    
    Throws:
    
    IOException
  - isXLong
```
public boolean isXLong()
```
    Description copied from interface: WaveData
    
    Check if absolute or relative times are used. Absolute times are stored as 8 bytes long. The time interpretation in jScope visualization will depend on the jScope.time_format property definition (default is Linux time format, can be EPICS or VMS). Relative times are represented by floating point
    
    Specified by:
    
    isXLong in interface WaveData
    
    Returns:
    
    true if absolute times are used, false otherwise
  - removeWaveDataListener
```
public void removeWaveDataListener(WaveDataListener listener)
```
    Description copied from interface: WaveData
    
    Unregister a WaveData listener.
    
    Specified by:
    
    removeWaveDataListener in interface WaveData
  - supportsStreaming
```
public boolean supportsStreaming()
```
    Description copied from interface: WaveData
    
    Check whether this data supports streaming
    
    Specified by:
    
    supportsStreaming in interface WaveData
    
    Returns:
    
    True if streaming is supported, false otherwise

Class XYWaveData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addWaveDataListener

getData

getData

getData

getDataAsync

getNumDimension

GetTitle

getX2D

getX2DLong

GetXLabel

getXLimits

getXLong

getY2D

GetYLabel

getZ

GetZLabel

isXLong

removeWaveDataListener

supportsStreaming