NI-RFSG Playback Library

niRFSGPlayback_DownloadUserWaveformComplexF32

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus __stdcall niRFSGPlayback_DownloadUserWaveformComplexF32 (ViSession rfsgSession, ViConstString rfsgWaveformName, ViReal64 t0, ViReal64 dt, NIComplexNumberF32 waveform[], ViInt32 waveformSize, ViInt32 burstPresent);

Purpose

Normalizes the input waveform and writes it into the NI RF vector signal generator. This VI computes the peak to average power ratio (PAPR) using the bursts in the waveform, stores the PAPR, sample rate, waveform size, and runtime scaling value of -1.5 dB in the NI-RFSG waveform database.

Parameters

Input
Name Type Description
rfsgSession ViSession Identifies the instrument session. rfsgSession is obtained from either the niRFSG_init function or the niRFSG_InitWithOptions function.
rfsgWaveformName ViConstString Specifies the name used to write the waveform to the NI-RFSG device memory.
t0 ViReal64 Specifies the start time of the given input waveform.
dt ViReal64 Specifies the time interval between the samples in the given input waveform.
waveform NIComplexNumberF32[] Specifies an array of the complex single waveform clusters to be downloaded to the device.
waveformSize ViInt32 Specifies the size of the waveform array.
burstPresent ViInt32 Specifies whether the burst is present in the given waveform.

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. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSGPlayback_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience