RfsgArb.WriteWaveform Method (String, ComplexSingle[], Boolean)
- Updated2024-05-08
- 2 minute(s) read
RfsgArbWriteWaveform Method (String, ComplexSingle, Boolean)
Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory.
Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022
Syntax
public void WriteWaveform( string name, ComplexSingle[] data, bool moreDataPending )
Public Sub WriteWaveform ( name As String, data As ComplexSingle(), moreDataPending As Boolean )
Parameters
- name
- Type: SystemString
Specifies the name used to identify the waveform. This string is case-insensitive, alphanumeric, and does not use reserved words. - data
- Type: NationalInstrumentsComplexSingle
Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the size_in_samples parameter in AllocateWaveform(String, Int32). - moreDataPending
- Type: SystemBoolean
Specifies whether or not the data block contains the end of the waveform. Set this parameter to TrueString to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set moreDataPending to FalseString to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The WriteWaveform(String, Double, Double) method was accessed after the associated NIRfsg object was disposed. |
Remarks
This method accepts the complex baseband data in the form of complex singles. To write data in blocks on these devices, you must allocate the waveform before writing it.
If the waveform to write is already allocated using AllocateWaveform(String, Int32), the moreDataPending parameter is ignored. On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840, the moreDataPending parameter is always ignored.
The PXI-5670/5671 must be in the Configuration state before you call this method.
When streaming is enabled, you can call this method when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840 is in the Generation state.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840