User manual

2.3.111 AcqrsT3_readData
Purpose
Returns all Time-to-Digital Converter information. The sample data is returned in a model dependent form
and as specified in the AqT3ReadParameters structure.
Parameters
Input
Name Type Description
instrumentID ViSession Instrument identifier
channel ViInt32 Reserved for future use (must be set to 0)
readPar AqT3ReadParameters Requested parameters for the acquired data.
Output
Name Type Description
dataDesc AqT3DataDescriptor Data descriptor structure needed for interpretation
Return Value
Name Type Description
status ViStatus Refer to Table 2-1 for error codes.
Read Parameters in AqT3ReadParameters
Name Type Description
dataArray ViAddr User-allocated time value data buffer .
dataSizeInBytes ViUInt32 Number of bytes in the user-allocated dataArray. Used
for verification / protection. See discussion for required
size.
nbrSamples ViInt32 Number of samples requested. For the TC890 is it used
for the maximum number of 4-byte structures to be
returned by the read (see dataType = 4 discussion
below
dataType ViInt32 Type representation of the data
4 = ReadRawData = raw format = 4 bytes as used
for the (TC890 TOF mode)
3 = ReadReal64 = 64-bit (double) = 8 bytes
2 = ReadInt32 = 32-bit (integer) = 4 bytes
readMode ViInt32 0 = AqT3ReadStandard = standard readout mode
1 = AqT3ReadContinuous = TOF mode - TC890 only
reserved3 ViInt32 Reserved for future use
reserved2 ViInt32 Reserved for future use
reserved1 ViInt32 Reserved for future use
Data Descriptor AqT3DataDescriptor
Name Type Description
dataPtr ViAddr Pointer to time value data buffer.
May differ from dataArray above!
nbrSamples ViInt32 number of samples returned
sampleSize ViInt32 Size in bytes of the time data format in use
sampleType ViInt32 type of the returned samples, see AqT3SampleType
flags ViInt32 For TC890 ONLY
Bit 0: Internal memory overflow flag
Bit 1: External memory overflow flag
reserved3 ViInt32 Reserved for future use
reserved2 ViInt32 Reserved for future use
reserved1 ViInt32 Reserved for future use
Programmer’s Reference Manual Page 201 of 210