AIOUSB::AI16_DataSet Class Reference

#include <AI16_DataSet.hpp>

Collaboration diagram for AIOUSB::AI16_DataSet:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~AI16_DataSet ()
AnalogInputSubsystemgetSubsystem ()
const AI16_DataPointArraygetPoints ()
long getTimeStamp ()
int getCalMode ()
int getTriggerMode ()
int getOverSample ()
bool isDiscardFirstSample ()
std::ostream & print (std::ostream &out)

Protected Member Functions

 AI16_DataSet (AnalogInputSubsystem &subsystem, int numPoints, long timeStamp, int calMode, int triggerMode, int overSample, bool discardFirstSample)

Protected Attributes

AnalogInputSubsystemsubsystem
AI16_DataPointArray points
long timeStamp
int calMode
int triggerMode
int overSample
bool discardFirstSample

Friends

class AnalogInputSubsystem


Detailed Description

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( int startChannel, int numChannels )

Constructor & Destructor Documentation

AIOUSB::AI16_DataSet::AI16_DataSet ( AnalogInputSubsystem subsystem,
int  numPoints,
long  timeStamp,
int  calMode,
int  triggerMode,
int  overSample,
bool  discardFirstSample 
) [protected]

AIOUSB::AI16_DataSet::~AI16_DataSet (  )  [virtual]

Destructor for data set. Data sets returned by methods such as AnalogInputSubsystem::read() must be explicitly destroyed.


Member Function Documentation

int AIOUSB::AI16_DataSet::getCalMode (  )  [inline]

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

int AIOUSB::AI16_DataSet::getOverSample (  )  [inline]

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

const AI16_DataPointArray& AIOUSB::AI16_DataSet::getPoints (  )  [inline]

Gets the data point array from this data set.

Returns:
The data point array from this data set.

AnalogInputSubsystem& AIOUSB::AI16_DataSet::getSubsystem (  )  [inline]

Gets the subsystem from which this data set was obtained.

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

long AIOUSB::AI16_DataSet::getTimeStamp (  )  [inline]

Gets the approximate time stamp when this data set was captured. The system time (obtained from time()) 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.

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

int AIOUSB::AI16_DataSet::getTriggerMode (  )  [inline]

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

bool AIOUSB::AI16_DataSet::isDiscardFirstSample (  )  [inline]

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

std::ostream & AIOUSB::AI16_DataSet::print ( std::ostream &  out  ) 

Prints this data set. Mainly useful for diagnostic purposes.

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


Friends And Related Function Documentation

friend class AnalogInputSubsystem [friend]


Member Data Documentation


doxygen