Functions

Methods

Functions

void dataqsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.
virtual void dsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.
void di194_dsdk::ADChannelList (const int *const ChannelList)
 Map software channels and physical channels.
void dataqsdk::ADDiffList (const int *const DiffList)
virtual void dsdk::ADDiffList (const int *const DiffList)
virtual void dsdk::ADGainList (const int *const GainList)
void dataqsdk::ADGainList (const int *const GainList)
void dataqsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.
void di194_dsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.
virtual void dsdk::ADMethodList (const int *const MethodList)
 Change the IOS setting for each channel.
void dataqsdk::DAOutput (const int value, const int port)
virtual void dsdk::DAOutput (const int value, const int port)
const char *const dataqsdk::DetectedDevices ()
void di194_dsdk::DeviceConnect ()
 Activate device connection.
void di194_dsdk::DeviceDisconnect ()
 Safely deactivate device connection.
virtual const long int dsdk::DigitalInput ()
const long int dataqsdk::DigitalInput ()
void dataqsdk::DigitalOutput (const int value)
virtual void dsdk::DigitalOutput (const int value)
void dataqsdk::GetData ()
virtual void dsdk::GetData ()
void di194_dsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.
void dataqsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.
virtual void dsdk::GetDataEx (short int *iArray, const int Count)
 Get acquired data from device.
virtual void dsdk::GetDataFrame ()
void dataqsdk::GetDataFrame ()
void dataqsdk::GetDataFrameEx (short int *iArray, const int Count)
virtual void dsdk::GetDataFrameEx (short int *iArray, const int Count)
void dataqsdk::Start ()
 Start acquisition.
virtual void dsdk::Start ()
 Start acquisition.
void di194_dsdk::Start ()
 Start acquisition.
void dataqsdk::Stop ()
 Stop acquisition.
void di194_dsdk::Stop ()
 Stop acquisition.
virtual void dsdk::Stop ()
 Stop acquisition.

Function Documentation

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

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:
ChannelListPointer to array containing the channel list.

Definition at line 825 of file dataqsdk.cpp.

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

Reimplemented in di194_dsdk.

Definition at line 289 of file dsdk.cpp.

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

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:
ChannelListPointer to array containing the channel list.

Reimplemented from dsdk.

Definition at line 408 of file di194.cpp.

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:
DiffListNOT FINISHED

Definition at line 852 of file dataqsdk.cpp.

void dsdk::ADDiffList ( const int *const   DiffList ) [virtual, inherited]

Definition at line 294 of file dsdk.cpp.

void dsdk::ADGainList ( const int *const   GainList ) [virtual, inherited]

Definition at line 299 of file dsdk.cpp.

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:
GainListNOT FINISHED

Definition at line 879 of file dataqsdk.cpp.

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

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:
MethodListPointer to array containing the IOS values to use.

Definition at line 911 of file dataqsdk.cpp.

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

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:
MethodListPointer to array containing the IOS values to use.

Reimplemented from dsdk.

Definition at line 553 of file di194.cpp.

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

Reimplemented in di194_dsdk.

Definition at line 304 of file dsdk.cpp.

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:
valueNOT FINISHED
portNOT FINISHED

Definition at line 938 of file dataqsdk.cpp.

void dsdk::DAOutput ( const int  value,
const int  port 
) [virtual, inherited]

Definition at line 309 of file dsdk.cpp.

const char *const dataqsdk::DetectedDevices (  ) [inherited]

Definition at line 955 of file dataqsdk.cpp.

void di194_dsdk::DeviceConnect (  ) [virtual, inherited]

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 598 of file di194.cpp.

Here is the call graph for this function:

void di194_dsdk::DeviceDisconnect (  ) [virtual, inherited]

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 645 of file di194.cpp.

Here is the call graph for this function:

const long int dsdk::DigitalInput (  ) [virtual, inherited]

Definition at line 324 of file dsdk.cpp.

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.

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

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

Parameters:
valueNOT FINISHED

Definition at line 990 of file dataqsdk.cpp.

void dsdk::DigitalOutput ( const int  value ) [virtual, inherited]

Definition at line 330 of file dsdk.cpp.

void dataqsdk::GetData (  ) [inherited]

Definition at line 1002 of file dataqsdk.cpp.

void dsdk::GetData (  ) [virtual, inherited]

Definition at line 335 of file dsdk.cpp.

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

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:
iArrayPointer to array which will hold the acquired data.
CountNumber of data points to store into array.

Reimplemented from dsdk.

Definition at line 690 of file di194.cpp.

Here is the call graph for this function:

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

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:
iArrayPointer to array which will hold the acquired data.
CountNumber of data points to store into array.

Definition at line 1040 of file dataqsdk.cpp.

void dsdk::GetDataEx ( short int *  iArray,
const int  Count 
) [virtual, inherited]

Reimplemented in di194_dsdk.

Definition at line 340 of file dsdk.cpp.

void dsdk::GetDataFrame (  ) [virtual, inherited]

Definition at line 345 of file dsdk.cpp.

void dataqsdk::GetDataFrame (  ) [inherited]

Definition at line 1052 of file dataqsdk.cpp.

void dataqsdk::GetDataFrameEx ( short int *  iArray,
const int  Count 
) [inherited]

Definition at line 1064 of file dataqsdk.cpp.

void dsdk::GetDataFrameEx ( short int *  iArray,
const int  Count 
) [virtual, inherited]

Definition at line 350 of file dsdk.cpp.

void dataqsdk::Start (  ) [inherited]

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.

void dsdk::Start (  ) [virtual, inherited]

Reimplemented in di194_dsdk.

Definition at line 355 of file dsdk.cpp.

void di194_dsdk::Start (  ) [virtual, inherited]

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 827 of file di194.cpp.

Here is the call graph for this function:

void dataqsdk::Stop (  ) [inherited]

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.

void di194_dsdk::Stop (  ) [virtual, inherited]

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 863 of file di194.cpp.

Here is the call graph for this function:

void dsdk::Stop (  ) [virtual, inherited]

Reimplemented in di194_dsdk.

Definition at line 360 of file dsdk.cpp.