User manual

2.3.86 AcqrsD1_readData
Purpose
Returns all waveform information. The sample data is returned in an array whose type is specified in the
AqReadParameters structure.
Parameters
Input
Name Type Description
instrumentID ViSession Instrument identifier
channel ViInt32 1...Nchan
readPar AqReadParameters Requested parameters for the acquired waveform.
Output
Name Type Description
dataArray ViAddr User-allocated waveform destination array.
The array size restrictions are given below.
ViAddr resolves to void* in C/C++.
dataDesc AqDataDescriptor Waveform descriptor structure, containing waveform
information that is common to all segments.
segDescArray ViAddr Segment descriptor structure array, containing data that
is specific for each segment. The size of the array is
defined by nbrSegments and the type by readMode.If
readMode =4 there are no segment descriptors.
Return Value
Name Type Description
status ViStatus Refer to Table 2-1 for error codes.
Read Parameters in AqReadParameters
Name Type Description
dataType ViInt32 Type representation of the waveform
0 = 8-bit (char) = 1 byte
1 = 16-bit (short ) = 2 bytes
2 = 32-bit (long ) = 4 bytes
3 = 64-bit (double) = 8 bytes
readMode ViInt32 readout mode of the digitizer
0 = standard waveform (single segment only)
1 = image read for sequence waveform
2 = averaged waveform (from an Averager ONLY)
3 = gated waveform (from an AP101/AP201 ONLY)
4 = peaks (from an AP101/AP201 or Peak
TDC
)
5 = short averaged waveform (from an Averager)
6 = shifted short averaged waveform (from an
Averager)
7 = gated data from an SSR or Peak
TDC
Analyzer
9 = Peak
TDC
Histogram readout from an Analyzer
10 = Peak
TDC
Peak region readout from an
Analyzer
11 = raw sequence waveform read
firstSegment ViInt32 Requested first segment number, may assume 0 to the
(number of segments – 1).
nbrSegments ViInt32 Requested number of segments, may assume 1 to the
actual number of segments.
firstSampleInSeg ViInt32 Requested position of first sample to read, typically 0.
May assume 0 to the actual (number of samples – 1).
Programmer’s Reference Manual Page 163 of 210