jScope
"MDSplus java signal viewer"
jScope.WaveData Interface Reference
Inheritance diagram for jScope.WaveData:
jScope.XYWaveData

Public Member Functions

int getNumDimension () throws IOException
 
XYData getData (double xmin, double xmax, int numPoints) throws Exception
 
XYData getData (int numPoints) throws Exception
 
float[] getZ ()
 
double[] getX2D ()
 
float[] getY2D ()
 
long[] getX2DLong ()
 
boolean isXLong ()
 
void addWaveDataListener (WaveDataListener listener)
 
String GetTitle () throws IOException
 
String GetXLabel () throws IOException
 
String GetYLabel () throws IOException
 
String GetZLabel () throws IOException
 
void getDataAsync (double lowerBound, double upperBound, int numPoints)
 
void setContinuousUpdate (boolean continuousUpdate)
 

Detailed Description

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

Definition at line 12 of file WaveData.java.

Member Function Documentation

void jScope.WaveData.addWaveDataListener ( WaveDataListener  listener)

Implemented in jScope.XYWaveData.

XYData jScope.WaveData.getData ( double  xmin,
double  xmax,
int  numPoints 
) throws Exception

Get Y data (for unidimensional signals) or Z data (for bidimensional signals) as a float array. If bidimensional signals are returned, values are ordered by rows.

Returns
The signal Y or Z data coded as a float array.
Exceptions
java.io.IOException

Implemented in jScope.XYWaveData.

XYData jScope.WaveData.getData ( int  numPoints) throws Exception

Implemented in jScope.XYWaveData.

void jScope.WaveData.getDataAsync ( double  lowerBound,
double  upperBound,
int  numPoints 
)

Start data readout. Expected to return soon, being the data segment communicated later

Parameters
lowerBoundLower bound of X region of interest
upperBoundUpper bound of X region of interest
numPointsEstimated number of requested point

Implemented in jScope.XYWaveData.

int jScope.WaveData.getNumDimension ( ) throws IOException

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

Returns
The number of dimension for the represented signal.
Exceptions
java.io.IOException

Implemented in jScope.XYWaveData.

String jScope.WaveData.GetTitle ( ) throws IOException

Implemented in jScope.XYWaveData.

double [] jScope.WaveData.getX2D ( )

Implemented in jScope.XYWaveData.

long [] jScope.WaveData.getX2DLong ( )

Implemented in jScope.XYWaveData.

String jScope.WaveData.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.
Exceptions
java.io.IOException

Implemented in jScope.XYWaveData.

float [] jScope.WaveData.getY2D ( )

Implemented in jScope.XYWaveData.

String jScope.WaveData.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.
Exceptions
java.io.IOException

Implemented in jScope.XYWaveData.

float [] jScope.WaveData.getZ ( )

Implemented in jScope.XYWaveData.

String jScope.WaveData.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.
Exceptions
java.io.IOException

Implemented in jScope.XYWaveData.

boolean jScope.WaveData.isXLong ( )

Implemented in jScope.XYWaveData.

void jScope.WaveData.setContinuousUpdate ( boolean  continuousUpdate)

Enables/Disables the option of periodic readout of new data

Parameters
continuousUpdate

Implemented in jScope.XYWaveData.