niRFSA_ReadIQSingleRecordComplexF64

NI RF Vector Signal Analyzers

previous page next page

niRFSA_ReadIQSingleRecordComplexF64

ViStatus = niRFSA_ReadIQSingleRecordComplexF64( ViSession vi, ViConstString channelList, ViReal64 timeout, NIComplexNumber* data, ViInt64 dataArraySize, niRFSA_wfmInfo* wfmInfo);

Purpose

Initiates an acquisition and fetches a single IQ data record. Do not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session.
channelList ViConstString Specifies channels from which to fetch data.
timeout ViReal64 Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of -1 specifies the function waits until all data is available.
dataArraySize ViInt32 Specifies the size of the array for the data parameter. The array needs to be at least as large as the number of samples configured in the niRFSA_ConfigureNumberOfSamples function.
Output
Name Type Description
data NIComplexNumber* Returns the acquired waveform.
wfmInfo* niRFSA_wfmInfo Returns additional information about the data array.

The following list provides more information about each of these properties:
  • absolute timestamp—specifies the timestamp in seconds of the first fetched sample that is comparable between records and acquisitions.
  • relative timestamp—returns a timestamp that corresponds to the difference in seconds between the first sample returned and the Reference trigger location.
  • dt—returns the time interval between data points in the acquired signal. The IQ data sampling rate is the reciprocal of this value.
  • actual samples read—returns an integer representing the number of samples in the waveform.
  • offset—specifies the offset to scale data in mx+b form.
  • gain—specifies the gain to scale data in mx+b form.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the status code, call the niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value
 Meaning
0 Success
Positive Values Warnings
Negative Values Errors
previous page start next page