nl.lxtreme.ols.api.tools
Interface ToolContext


public interface ToolContext

Denotes the context in which a tool is to be run.

For example, it provides the information about which range of samples should be analysed.


Method Summary
 int getChannels()
          Returns the number of channels in the sample data.
 Cursor getCursor(int aSelectedIndex)
           
 AcquisitionResult getData()
          Returns the acquisition result for use in the tool.
 int getEnabledChannels()
          Returns a bitmask of enabled channels in the sample data.
 int getEndSampleIndex()
          Returns the ending sample index on which the decoding should end.
 int getLength()
          Returns the length of the decoding area.
 int getStartSampleIndex()
          Returns the starting sample index on which the decoding should start.
 

Method Detail

getChannels

int getChannels()
Returns the number of channels in the sample data.

Returns:
the channel count, >= 0.

getCursor

Cursor getCursor(int aSelectedIndex)
Parameters:
aSelectedIndex -
Returns:

getData

AcquisitionResult getData()
Returns the acquisition result for use in the tool.

Returns:
the data to be analyzed, never null.

getEnabledChannels

int getEnabledChannels()
Returns a bitmask of enabled channels in the sample data.

Returns:
a bitmask of enabled channels, for example, 0xFF for the first 8 channels.

getEndSampleIndex

int getEndSampleIndex()
Returns the ending sample index on which the decoding should end.

Returns:
a end sample index, >= 0.

getLength

int getLength()
Returns the length of the decoding area.

Returns:
a decoding length, >= 0.

getStartSampleIndex

int getStartSampleIndex()
Returns the starting sample index on which the decoding should start.

Returns:
a start sample index, >= 0.


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