mds.wave

Interface WaveData

All Known Implementing Classes:

XYWaveData

public interface WaveData

When a signal is requested to a DataProvider, it is returned by means of an object implementing WaveData interface. WaveData defines all the data access method for the corresponding signal.

See Also:

DataProvider

Method Summary

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.
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 bi-dimensional 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

Method Detail

addWaveDataListener

void addWaveDataListener(WaveDataListener listener)

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.

Parameters:

listener: - The passed WaveDataListener instance.

See Also:

WaveDataListener

getData

XYData getData(double xmin,
               double xmax,
               int numPoints)
        throws IOException

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

Parameters:

xmin: - Lower bound of X region of interest

xmax: - Upper bound of X region of interest

numPoints: - The suggested number of samples. The returned number of samples actually returned in XYData instance can be different, it is up to the DataProvider implementation decide the resampling policy. The passed number is a hint from jScope

Returns:

The XYData instance describing X and Y values of the returned signal.

Throws:

IOException

See Also:

XYData

getData

XYData getData(int numPoints)
        throws IOException

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

Parameters:

numPoints: - The suggested number of samples. The returned number of samples actually returned in XYData instance can be different, it is up to the DataProvider implementation decide the resampling policy. The passed number is a hint from jScope

Returns:

The XYData instance describing X and Y values of the returned signal.

Throws:

IOException

See Also:

XYData

getData

XYData getData(long xmin,
               long xmax,
               int numPoints)
        throws IOException

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

Parameters:

xmin: - Lower bound of X region of interest

xmax: - Upper bound of X region of interest

numPoints: - The suggested number of samples. The returned number of samples actually returned in XYData instance can be different, it is up to the DataProvider implementation decide the resampling policy. The passed number is a hint from jScope

Returns:

The XYData instance describing X and Y values of the returned signal.

Throws:

IOException

See Also:

XYData

getDataAsync

void getDataAsync(double lowerBound,
                  double upperBound,
                  int numPoints)

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().

Parameters:

lowerBound: - Lower bound of X region of interest

upperBound: - Upper bound of X region of interest

numPoints: - Estimated number of requested point

getNumDimension

int getNumDimension()
             throws IOException

Returns the number of dimensions of the corresponding signal. Currently only unidimensional and bidimensional signals are supported by jScope.

Returns:

The number of dimension for the represented signal.

Throws:

IOException

GetTitle

String GetTitle()
         throws IOException

Get the title associated with that signal. It is displayed if no title is defined in the setup data definition.

Returns:

The title string.

Throws:

IOException

getX2D

double[] getX2D()

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

Returns:

The unidimensional array of X values.

getX2DLong

long[] getX2DLong()

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

Returns:

The unidimensional array of X values.

GetXLabel

String GetXLabel()
          throws IOException

Get the associated label for X axis. It is displayed if no X axis label is defined in the setup data definition.

Returns:

The X label string.

Throws:

IOException

getY2D

float[] getY2D()

Get Y data for bidimensional signals. Called when the returned number of dimensions is 2

Returns:

The unidimensional array of Y values.

GetYLabel

String GetYLabel()
          throws IOException

Get the associated label for Y axis. It is displayed if no Y axis label is defined in the setup data definition.

Returns:

The Y label string.

Throws:

IOException

getZ

float[] getZ()

Get Z data for bidimensional signals. Called when the returned number of dimensions is 2

Returns:

The bisimensional array of Z values (z=f(x,y)). Row first order is assumed.

GetZLabel

String GetZLabel()
          throws IOException

Get the associated label for Z axis (for bi-dimensional signals only). It is displayed if no X axis label is defined in the setup data definition.

Returns:

The Z label string.

Throws:

IOException

isXLong

boolean isXLong()

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

Returns:

true if absolute times are used, false otherwise

removeWaveDataListener

void removeWaveDataListener(WaveDataListener listener)

Unregister a WaveData listener.

supportsStreaming

boolean supportsStreaming()

Check whether this data supports streaming

Returns:

True if streaming is supported, false otherwise