NIRfsgPlayback Class
- Updated2025-10-13
- 6 minute(s) read
Provides methods to generate the waveforms saved in a TDMS file using the NI-RFSG driver.
Derives from
None
Syntax
Namespace: NationalInstruments.ModularInstruments.NIRfsgPlayback
public class NIRfsgPlayback
Methods
| Name | Description |
|---|---|
| ClearAllWaveforms(IntPtr) | Deletes the waveforms from the NI-RFSG device memory and removes all the waveform properties from the NI-RFSG waveform properties database for the specified device. |
| ClearWaveform(IntPtr, string) | Deletes the waveform from the NI-RFSG device memory and removes the waveform properties from the NI-RFSG waveform properties database for the specified device. |
| DownloadUserWaveform(IntPtr, string, ComplexWaveform< ComplexDouble >, bool) | 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. |
| DownloadUserWaveform(IntPtr, string, ComplexWaveform< ComplexSingle >, bool) | 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. |
| GetError(out int, out string) | Gets the latest error code and description. |
| ReadAndDownloadWaveformFromFile(IntPtr, string, string) | Reads a waveform from a TDMS file, and downloads it to the NI RF vector signal generator. |
| ReadAndDownloadWaveformsFromFile(IntPtr[], string, string) | Reads the waveforms from a TDMS file, and downloads one waveform into each of the NI RF vector signal generators. The first waveform in the TDMS file is downloaded to the first NI RF vector signal generator and so on, until all the waveforms are downloaded. |
| ReadBurstStartLocationsFromFile(string, int, ref int[]) | Returns the RF burst start locations stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadBurstStopLocationsFromFile(string, int, ref int[]) | Returns the RF burst stop locations stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadPaprFromFile(string, int, out double) | Returns the peak to average power ratio (PAPR) stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadPeakPowerAdjustmentFromFile(string, int, out double) | Returns the value of the peak power adjustment stored in the file. This method uses the waveformIndex as the key to read the waveform properties. |
| ReadRFBlankingEnabledFromFile(string, int, out bool) | Returns the RF blanking enabled value stored in the file. This method uses the waveformIndex as the key to read the waveform properties. |
| ReadRFBlankingMarkerLocationsFromFile(string, int, ref int[]) | Returns the RF blanking marker locations stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadRFBlankingMarkerSourceFromFile(string, int, out string) | Returns the RF blanking marker source stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadRuntimeScalingFromFile(string, int, out double) | Returns the runtime scaling value stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadSampleRateFromFile(string, int, out double) | Returns the sample rate stored in the file. This method uses the waveformIndex as the key to read the waveform property. |
| ReadSignalBandwidthFromFile(string, int, out double) | Returns the signal bandwidth stored in the file. This method uses the waveformIndex parameter as the key to retrieve the waveform property. |
| ReadWaveformFileVersionFromFile(string, out string) | Returns the waveform file version of the waveform stored in the file. |
| ReadWaveformFromFileByIndexComplex(string, int, ref ComplexWaveform< ComplexSingle >) | Reads the waveform from file and returns the waveform in an output parameter. |
| ReadWaveformFromFileByIndexComplex(string, int, ref ComplexWaveform< ComplexDouble >) | Reads the waveform from file and returns the waveform in an output parameter. |
| ReadWaveformFromFileComplex(string, ref ComplexWaveform< ComplexSingle >) | Reads the waveform from file and returns the waveform in an output parameter. |
| ReadWaveformFromFileComplex(string, ref ComplexWaveform< ComplexDouble >) | Reads the waveform from file and returns the waveform in an output parameter. |
| ReadWaveformsFromFileComplex(string, int, ref ComplexWaveform< ComplexSingle >[]) | Reads the waveforms from file, and returns the waveforms in an output parameter. |
| ReadWaveformsFromFileComplex(string, int, ref ComplexWaveform< ComplexDouble >[]) | Reads the waveforms from file, and returns the waveforms in an output parameter. |
| ReadWaveformSizeFromFile(string, int, out int) | Returns the size of the waveform stored in the file. This method uses the waveformIndex parameter as the key to read the waveform property. |
| RetrieveAutomaticSGSASharedLO(IntPtr, string, out RfsgPlaybackAutomaticSGSASharedLO) | Returns the value of automatic SG SA shared LO parameter. |
| RetrieveDownloadedWaveformNames(IntPtr, out string[]) | Returns the names of the waveforms that are stored in the NI-RFSG waveform database. |
| RetrieveWaveformBurstStartLocations(IntPtr, string, ref int[]) | Returns the RF burst start positions property stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformBurstStopLocations(IntPtr, string, ref int[]) | Returns the RF burst stop positions property stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformFileVersion(IntPtr, string, out string) | Returns the waveform file version stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformLOOffsetMode(IntPtr, string, out NIRfsgPlaybackLOOffsetMode) | Returns the LO offset mode value stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformPapr(IntPtr, string, out double) | Returns the peak to average power ratio (PAPR) stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformPeakPowerAdjustment(IntPtr, string, out double) | Returns the value of the Peak Power Adjustment property stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformRFBlankingEnabled(IntPtr, string, out bool) | Returns the RF blanking enabled value stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform properties. |
| RetrieveWaveformRFBlankingMarkerLocations(IntPtr, string, ref int[]) | Returns the RF blanking marker positions property stored in the NI-RFSG waveform database. This method uses the waveformName as the key to retrieve the waveform property. |
| RetrieveWaveformRFBlankingMarkerSource(IntPtr, string, out string) | Returns the RF blanking marker source stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformRuntimeScaling(IntPtr, string, out double) | Returns the runtime scaling value stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformSampleRate(IntPtr, string, out double) | Returns the sample rate stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform properties. |
| RetrieveWaveformSignalBandwidth(IntPtr, string, out double) | Returns the signal bandwidth stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| RetrieveWaveformSize(IntPtr, string, out int) | Returns the size of the waveform stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform property. |
| SetScriptToGenerateMultipleRfsg(IntPtr[], string) | Sets the NI-RFSG driver to generate the waveforms specified in the script at the average power you configure on the NI-RFSG Power Level method. If you have enabled RF Blanking for the waveform, NI-RFSG is configured to correctly blank the output during the idle times of the waveform. |
| SetScriptToGenerateSingleRfsg(IntPtr, string) | Sets the NI-RFSG driver to generate the waveforms specified in the script at the average power you configure on the NI-RFSG Power Level method. If you have enabled RF Blanking for the waveform, NI-RFSG is configured to correctly blank the output during the idle times of the waveform. |
| StoreAutomaticSGSASharedLO(IntPtr, string, RfsgPlaybackAutomaticSGSASharedLO) | Stores whether the signal generator's LO signal can be shared on request by the RFmx driver. It is recommended to use Automatic sharing of local oscillator (LO) in test setups that use a vector signal transceiver (VST) with the NI-RFSG to generate a signal at the DUT's input and the RFmx driver to measure the signal at the DUT's output. |
| StoreWaveformBurstStartLocations(IntPtr, string, int[]) | Stores the RF burst start locations, which you specify in the burstStartLocations parameter, in the NI-RFSG waveform database. |
| StoreWaveformBurstStopLocations(IntPtr, string, int[]) | Stores the RF burst stop positions, which you specify in the burstStopLocations parameter, in the NI-RFSG waveform database. |
| StoreWaveformLOOffsetMode(IntPtr, string, NIRfsgPlaybackLOOffsetMode) | Stores the LO offset mode value, which you specify in the value parameter, in the NI-RFSG waveform database. |
| StoreWaveformPapr(IntPtr, string, double) | Stores the peak to average power ratio (PAPR), which you specify in the PAPR parameter, in the NI-RFSG waveform database. |
| StoreWaveformPeakPowerAdjustment(IntPtr, string, double) | Stores the peak power adjustment, which you specify in the peakPowerAdjustment parameter, in the RFSG waveform database. |
| StoreWaveformRFBlankingEnabled(IntPtr, string, bool) | Stores the RF blanking enabled value, which you specify in the rfBlankingEnabled parameter, in the NI-RFSG waveform database. |
| StoreWaveformRFBlankingMarkerLocations(IntPtr, string, int[]) | Stores the RF blanking marker positions, which you specify in the markerLocations parameter, in the NI-RFSG waveform database. |
| StoreWaveformRFBlankingMarkerSource(IntPtr, string, string) | Stores the RF blanking marker source, which you specify in the markerSource parameter, in the NI-RFSG waveform database. |
| StoreWaveformRuntimeScaling(IntPtr, string, double) | Stores the runtime scaling value, which you specify in the runtimeScaling parameter, in the NI-RFSG waveform database. |
| StoreWaveformSampleRate(IntPtr, string, double) | Stores the sample rate, which you specify in the sampleRate parameter, in the NI-RFSG waveform database. |
| StoreWaveformSignalBandwidth(IntPtr, string, double) | Stores the signal bandwidth, which you specify in the signalBandwidth parameter, in the NI-RFSG waveform database. |
| StoreWaveformSize(IntPtr, string, int) | Stores the size of the waveform, which you specify in the waveformSize parameter, in the NI-RFSG waveform database. |