Main Page | Modules | Class Hierarchy | Class List | File List | Class Members

Methods


Functions

void dataqsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.

void dataqsdk::ADDiffList (const int *const DiffList)
void dataqsdk::ADGainList (const int *const GainList)
void dataqsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.

void dataqsdk::DAOutput (const int value, const int port)
const char *const  DetectedDevices ()
const long int dataqsdk::DigitalInput ()
void dataqsdk::DigitalOutput (const int value)
void GetData ()
void dataqsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.

void GetDataFrame ()
void GetDataFrameEx (short int *iArray, const int Count)
void dataqsdk::Start ()
 Start acquisition.

void dataqsdk::Stop ()
 Stop acquisition.

void di194_dsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.

void di194_dsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.

void di194_dsdk::DeviceConnect ()
 Activate device connection.

void di194_dsdk::DeviceDisconnect ()
 Safely deactivate device connection.

void di194_dsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.

void di194_dsdk::Start ()
 Start acquisition.

void di194_dsdk::Stop ()
 Stop acquisition.

virtual void dsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.

virtual void ADDiffList (const int *const DiffList)
virtual void ADGainList (const int *const GainList)
virtual void dsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.

virtual void DAOutput (const int value, const int port)
virtual const long int DigitalInput ()
virtual void DigitalOutput (const int value)
virtual void GetData ()
virtual void dsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.

virtual void GetDataFrame ()
virtual void GetDataFrameEx (short int *iArray, const int Count)
virtual void dsdk::Start ()
 Start acquisition.

virtual void dsdk::Stop ()
 Stop acquisition.


Function Documentation

void dataqsdk::ADChannelList const int *const  ChannelList  )  [inherited]
 

Map software channels and physical channels.

Uses list to map software channels to a different order than the physical channels on the device. Each index in the list represents the software channel (which is therefore zero based). The value at that index represents the physical channel (which is also zero based).

Error Codes set:
EINVAL = Bad parameter pointer.
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Precondition:
Device dependent.
Parameters:
ChannelList Pointer to array containing the channel list.

Definition at line 825 of file dataqsdk.cpp.

References dsdk::ADChannelList(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::ADDiffList const int *const  DiffList  )  [inherited]
 

Error Codes set:
EINVAL = Bad parameter pointer.
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Parameters:
DiffList NOT FINISHED

Definition at line 852 of file dataqsdk.cpp.

References dsdk::ADDiffList(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::ADGainList const int *const  GainList  )  [inherited]
 

Error Codes set:
EINVAL = Bad parameter pointer.
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Parameters:
GainList NOT FINISHED

Definition at line 879 of file dataqsdk.cpp.

References dsdk::ADGainList(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::ADMethodList const int *const  MethodList  )  [inherited]
 

Change the IOS setting for each channel.

The method list determines what IOS method to apply to each channel. The list's index represents the physical channel (not the software channel). The value at that index represents the IOS method.

Error Codes set:
EINVAL = Bad parameter pointer.
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Precondition:
Device dependent.
Parameters:
MethodList Pointer to array containing the IOS values to use.

Definition at line 911 of file dataqsdk.cpp.

References dsdk::ADMethodList(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::DAOutput const int  value,
const int  port
[inherited]
 

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Parameters:
value NOT FINISHED
port NOT FINISHED

Definition at line 938 of file dataqsdk.cpp.

References dsdk::DAOutput(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

const long int dataqsdk::DigitalInput  )  [inherited]
 

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Definition at line 970 of file dataqsdk.cpp.

References dsdk::DigitalInput(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::DigitalOutput const int  value  )  [inherited]
 

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Parameters:
value NOT FINISHED

Definition at line 990 of file dataqsdk.cpp.

References dsdk::DigitalOutput(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::GetDataEx short int *  iArray,
const int  Count
[inherited]
 

Get acquired data from device.

Stores acquired data into the array provided. iArray must already have memory allocated to it. Count represents the number of data points (array elements) to store into iArray.

The function will block until it either gets the requested data OR it times out. There is no overall timeout value, only a timeout between one good scan and the next. This means that the function could take different amounts of time to acquire data depending on the frequency of good scans.

The function stores the data as 'Counts'. The values have the same range as a 'short int', hence the data type. A Count of zero means a Voltage of zero on the channel.

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Precondition:
Bounds for Count between 1 and 32767.
Valid iArray pointer.
Acquiring.
Parameters:
iArray Pointer to array which will hold the acquired data.
Count Number of data points to store into array.

Definition at line 1040 of file dataqsdk.cpp.

References dsdk::GetDataEx(), dataqsdk::m_classID, and dataqsdk::m_last_error.

Here is the call graph for this function:

void dataqsdk::Start  )  [inherited]
 

Start acquisition.

Tells device to start acquisition.

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Precondition:
Not acquiring.
Connected.
Remarks:
Sets flag that device is acquiring.

Definition at line 1088 of file dataqsdk.cpp.

References dataqsdk::m_classID, dataqsdk::m_last_error, and dsdk::Start().

Here is the call graph for this function:

void dataqsdk::Stop  )  [inherited]
 

Stop acquisition.

Tells device to stop acquisition.

Error Codes set:
ENODEV = No device specified.
ENOSYS = Function not supported.
Other codes are device dependent.

Precondition:
Acquiring.
Connected.
Remarks:
Sets acquiring flag.

Definition at line 1112 of file dataqsdk.cpp.

References dataqsdk::m_classID, dataqsdk::m_last_error, and dsdk::Stop().

Here is the call graph for this function:

void di194_dsdk::ADChannelList const int *const  ChannelList  )  [virtual, inherited]
 

Map software channels and physical channels.

Uses list to map software channels to a different order than the physical channels on the device. Each index in the list represents the software channel (which is therefore zero based). The value at that index represents the physical channel (which is also zero based).

Sets up the chan_order list to correctly map the new channel order. Tells device which channels to scan (it is now possible to tell the difference between analog and digital channels).

Error Codes set:
EBUSY = Acquiring.
ENOLINK = Not connected.
EINVAL = Bad parameter pointer.
EBOUNDS = Parameter value(s) out of bounds.
Errors set by Dcmd().
Errors set by Ccmd().

Precondition:
Not acquiring.
Connected.
Valid pointer. Only one digital channel. At least one analog channel.
Bounds between (-1) and (DI194_CHANNELS-1)
Parameters:
ChannelList Pointer to array containing the channel list.

Reimplemented from dsdk.

Definition at line 403 of file di194.cpp.

References Ccmd(), di194_dsdk::chan_order, Dcmd(), di194_dsdk::digital_chan, EBOUNDS, di_serial_io::is_comm_open(), and di194_dsdk::m_connection.

Here is the call graph for this function:

void di194_dsdk::ADMethodList const int *const  MethodList  )  [virtual, inherited]
 

Change the IOS setting for each channel.

The method list determines what IOS method to apply to each channel. The list's index represents the physical channel (not the software channel). The value at that index represents the IOS method.

Error Codes set:
EBUSY = Acquiring.
EINVAL = Bad parameter pointer.
EBOUNDS = Parameter value(s) out of bounds.

Precondition:
Not acquiring.
Valid pointer.
Parameters:
MethodList Pointer to array containing the IOS values to use.

Reimplemented from dsdk.

Definition at line 548 of file di194.cpp.

References EBOUNDS.

void di194_dsdk::DeviceConnect  )  [virtual, inherited]
 

Activate device connection.

Sets up connection, connects to device. Disconnects on connection failure.

Error Codes set:
EBUSY = Acquiring.
ENODEV = Device file not set.
EALREADY = Already connected.
Errors returned by di_serial_io::connect(). Errors set by DeviceDisconnect().
Errors set by Stop().

Precondition:
Not acquiring.
Device file set.
Not connected.

Reimplemented from dsdk.

Definition at line 593 of file di194.cpp.

References di_serial_io::connect(), di194_dsdk::DeviceDisconnect(), di_serial_io::is_comm_open(), di194_dsdk::m_connection, and di194_dsdk::Stop().

Here is the call graph for this function:

void di194_dsdk::DeviceDisconnect  )  [virtual, inherited]
 

Safely deactivate device connection.

Stops acquiring if it hasn't been stopped yet. Resets acquisition flag. Attempts to disconnect. Should reset serial connection settings back to their original values if at all possible.

Error Codes set:
Errors returned by di_serial_io::disconnect().

Postcondition:
Not acquiring.
Not connected.

Reimplemented from dsdk.

Definition at line 640 of file di194.cpp.

References di_serial_io::disconnect(), di_serial_io::is_comm_open(), di194_dsdk::m_connection, and di194_dsdk::Stop().

Referenced by di194_dsdk::DeviceConnect(), and di194_dsdk::~di194_dsdk().

Here is the call graph for this function:

void di194_dsdk::GetDataEx short int *  iArray,
const int  Count
[virtual, inherited]
 

Get acquired data from device.

Stores acquired data into the array provided. iArray must already have memory allocated to it. Count represents the number of data points (array elements) to store into iArray.

The function will block until it either gets the requested data OR it times out. There is no overall timeout value, only a timeout between one good scan and the next. This means that the function could take different amounts of time to acquire data depending on the frequency of good scans.

The function stores the data as 'Counts'. The values have the same range as a 'short int', hence the data type. A Count of zero means a Voltage of zero on the channel.

The function enforces the sample rate and applies the properties of the variously supported lists.

Error Codes set:
EBOUNDS = Count is out of bounds.
EINVAL = Bad parameter pointer.
ENODATA = Not acquiring.
Errors set by di_serial_io::di_read().

Precondition:
Bounds for Count between 1 and 32767
Valid iArray pointer
Acquiring
Parameters:
iArray Pointer to array which will hold the acquired data.
Count Number of data points to store into array.

Reimplemented from dsdk.

Definition at line 685 of file di194.cpp.

References di194_dsdk::convert(), di_serial_io::di_read(), di194_dsdk::digital_chan, EBOUNDS, and di194_dsdk::m_connection.

Here is the call graph for this function:

void di194_dsdk::Start  )  [virtual, inherited]
 

Start acquisition.

Tells device to start acquisition.

Error Codes set:
EALREADY = Acquiring.
ENOLINK = Not connected.
Errors set by Scmd().

Precondition:
Not acquiring.
Connected.
Remarks:
Sets flag that device is acquiring.

Reimplemented from dsdk.

Definition at line 822 of file di194.cpp.

References di_serial_io::is_comm_open(), di194_dsdk::m_connection, and Scmd().

Here is the call graph for this function:

void di194_dsdk::Stop  )  [virtual, inherited]
 

Stop acquisition.

Tells device to stop acquisition.

Error Codes set:
ENOLINK = Not connected.
Errors set by Scmd().

Precondition:
Acquiring.
Connected.
Remarks:
Sets acquiring flag.

Reimplemented from dsdk.

Definition at line 858 of file di194.cpp.

References di_serial_io::is_comm_open(), di194_dsdk::m_connection, and Scmd().

Referenced by di194_dsdk::DeviceConnect(), and di194_dsdk::DeviceDisconnect().

Here is the call graph for this function:


Generated on Mon Aug 2 09:45:21 2004 for DataqSDK by doxygen 1.3.6