nl.lxtreme.ols.api.data
Interface DataSet


public interface DataSet

Denotes a set of data, including the acquisition result, the channels and the cursors.


Method Summary
 AcquisitionResult getCapturedData()
          Returns the captured data of this project.
 Channel getChannel(int aIndex)
          Returns a single channel.
 Channel[] getChannels()
          Returns the channels of this project.
 Cursor getCursor(int aIndex)
          Returns a single cursor
 Cursor[] getCursors()
          Returns the available cursors of this project.
 boolean isCursorsEnabled()
          Returns whether or not cursors are enabled.
 void setCursorsEnabled(boolean aEnabled)
          Sets whether or not cursors are enabled.
 

Method Detail

getCapturedData

AcquisitionResult getCapturedData()
Returns the captured data of this project.

Returns:
a captured data, can be null.

getChannel

Channel getChannel(int aIndex)
Returns a single channel.

Parameters:
aIndex - the channel index, >= 0 && < AcquisitionResult.getChannels().
Returns:
an array of channels, never null.

getChannels

Channel[] getChannels()
Returns the channels of this project.

Returns:
an array of channels, never null.

getCursor

Cursor getCursor(int aIndex)
Returns a single cursor

Parameters:
aIndex - the index of the cursor to retrieve, >= 0.

getCursors

Cursor[] getCursors()
Returns the available cursors of this project.

Returns:
an array of cursors, never null.

isCursorsEnabled

boolean isCursorsEnabled()
Returns whether or not cursors are enabled.

Returns:
true if cursors are enabled, false otherwise.

setCursorsEnabled

void setCursorsEnabled(boolean aEnabled)
Sets whether or not cursors are enabled.

Parameters:
aEnabled - true if cursors are enabled, false otherwise.


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.