niRFSA_ReadIQSingleRecordComplexF64

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 I/Q data record. Do not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.

Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

None (Trigger Type)

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
channelList	ViConstString	Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
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	ViInt64	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. Allocate an NIComplexNumber array at least as large as the number of samples configured in the niRFSA_ConfigureNumberOfSamples function.
wfmInfo	niRFSA_wfmInfo*	Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. The following list provides more information about each of these properties: absolute timestamp—Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions. Note  The value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860. relative timestamp—Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred. Note  The value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646. dt—Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value. actual samples read—Returns an integer representing the number of samples in the waveform. offset—Returns the offset to scale data, (b), in mx + b form. gain—Returns the gain to scale data, (m), in mx + b form.

Return Value