AIOUSB::AI16_DataPoint Class Reference

#include <AI16_DataPoint.hpp>

List of all members.

Public Member Functions
int	getChannel () const
int	getRange () const
std::string	getRangeText () const
bool	isDifferentialMode () const
int	getCounts () const
double	getVolts () const
std::string	toString () const
Protected Member Functions
	AI16_DataPoint ()
Protected Attributes
int	counts
int	channel
int	range
bool	differentialMode
Friends
class	AI16_DataPointArray
class	AI16_DataSet
class	AnalogInputSubsystem
class	std::vector< AI16_DataPoint >

---

Detailed Description

Class AI16_DataPoint represents a single data point captured from a USB_AI16_Family device. It encapsulates not only the captured sample, but the channel from which the sample was captured and the range and differential mode in effect when the sample was captured, providing a fairly complete representation of the captured data. This class also provides methods to retrieve the captured data in either A/D counts or volts.

---

Constructor & Destructor Documentation

AIOUSB::AI16_DataPoint::AI16_DataPoint

(

)

[protected]

---

Member Function Documentation

int AIOUSB::AI16_DataPoint::getChannel

(

)

const [inline]

Gets the channel number from which this data point was captured.

Returns:

The channel number from which this data point was captured.

int AIOUSB::AI16_DataPoint::getCounts

(

)

const [inline]

Gets the captured data in A/D counts.

Returns:

The captured data in A/D counts.

int AIOUSB::AI16_DataPoint::getRange

(

)

const [inline]

Gets the range that was in effect when this data point was captured.

Returns:

The range that was in effect when this data point was captured.

See also:

AnalogInputSubsystem::getRange( int channel ) const

std::string AIOUSB::AI16_DataPoint::getRangeText

(

)

const

Gets the textual representation of the range that was in effect when this data point was captured.

Returns:

The textual representation of the range that was in effect when this data point was captured.

double AIOUSB::AI16_DataPoint::getVolts

(

)

const

Gets the captured data in volts.

Returns:

The captured data in volts.

bool AIOUSB::AI16_DataPoint::isDifferentialMode

(

)

const [inline]

Gets the differential/single-ended mode that was in effect when this data point was captured.

Returns:

The differential/single-ended mode that was in effect when this data point was captured.

See also:

AnalogInputSubsystem::isDifferentialMode( int channel ) const

std::string AIOUSB::AI16_DataPoint::toString

(

)

const

Gets a single-line string summary of this data point. Mainly useful for diagnostic purposes.

Returns:

A single-line string summary of this data point.

---

Friends And Related Function Documentation

friend class AI16_DataPointArray [friend]

friend class AI16_DataSet [friend]

friend class AnalogInputSubsystem [friend]

friend class std::vector< AI16_DataPoint > [friend]

---

Member Data Documentation

int AIOUSB::AI16_DataPoint::channel [protected]

int AIOUSB::AI16_DataPoint::counts [protected]

bool AIOUSB::AI16_DataPoint::differentialMode [protected]

int AIOUSB::AI16_DataPoint::range [protected]