com.acces.aiousb
Class AI16_DataSet

java.lang.Object
  extended by com.acces.aiousb.AI16_DataSet

public class AI16_DataSet
extends java.lang.Object

Class AI16_DataSet represents a data set captured from a USB_AI16_Family device. It comprises a fairly complete snapshot of both the data and the sampling parameters, including a time stamp.

See Also:
AnalogInputSubsystem.read()

Method Summary
 int getCalMode()
          Gets the calibration mode that was in effect when this data set was captured.
 int getOverSample()
          Gets the over-sample setting that was in effect when this data set was captured.
 AI16_DataPoint[] getPoints()
          Gets the data point array from this data set.
 AnalogInputSubsystem getSubsystem()
          Gets the subsystem from which this data set was obtained.
 long getTimeStamp()
          Gets the approximate time stamp when this data set was captured.
 int getTriggerMode()
          Gets the trigger mode that was in effect when this data set was captured.
 boolean isDiscardFirstSample()
          Gets the sample discard mode that was in effect when this data set was captured.
 java.io.PrintStream print(java.io.PrintStream stream)
          Prints this data set.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSubsystem

public AnalogInputSubsystem getSubsystem()
Gets the subsystem from which this data set was obtained.

Returns:
The subsystem from which this data set was obtained.

getPoints

public AI16_DataPoint[] getPoints()
Gets the data point array from this data set.

Returns:
The data point array from this data set.

getTimeStamp

public long getTimeStamp()
Gets the approximate time stamp when this data set was captured. The system time (obtained from System.currentTimeMillis()) is recorded immediately prior to the sampling of the data, so it approximately represents the time when the data capture started. This property is not intended to be precise, but merely to serve as a convenient reference. The time stamp may be converted to more useful forms using the java.util.Calendar or java.util.Date classes.

Returns:
The approximate time stamp when this data set was captured.

getCalMode

public int getCalMode()
Gets the calibration mode that was in effect when this data set was captured.

Returns:
The calibration mode that was in effect when this data set was captured.
See Also:
AnalogInputSubsystem.getCalMode()

getTriggerMode

public int getTriggerMode()
Gets the trigger mode that was in effect when this data set was captured.

Returns:
The trigger mode that was in effect when this data set was captured.
See Also:
AnalogInputSubsystem.getTriggerMode()

getOverSample

public int getOverSample()
Gets the over-sample setting that was in effect when this data set was captured.

Returns:
The over-sample setting that was in effect when this data set was captured.
See Also:
AnalogInputSubsystem.getOverSample()

isDiscardFirstSample

public boolean isDiscardFirstSample()
Gets the sample discard mode that was in effect when this data set was captured.

Returns:
The sample discard mode that was in effect when this data set was captured.
See Also:
AnalogInputSubsystem.isDiscardFirstSample()

print

public java.io.PrintStream print(java.io.PrintStream stream)
Prints this data set. Mainly useful for diagnostic purposes.

Parameters:
stream - the print stream where the data set will be printed.
Returns:
The print stream.