RfsgArb Class
- Updated2025-10-14
- 4 minute(s) read
Provides methods and properties used to configure the arbitrary waveform generator (AWG).
Derives from
Syntax
Namespace: NationalInstruments.ModularInstruments.NIRfsg
public class RfsgArb : RfsgSubObject
Remarks
For more information, refer to the NI-RFSG Instrument Driver Programming Flow topic in the NI RF Signal Generators Help.
Properties
| Name | Description |
|---|---|
| AbsoluteDelay | Gets or sets the sub-Sample Clock delay, in seconds, to apply to the I/Q waveform. |
| BurstDetection | Gets properties used to configure burst detection of waveform. |
| CarrierFrequency | Gets or sets the carrier frequency, in Hertz (Hz), of the signal generated by the arbitrary waveform generator (AWG) module. |
| DataTransfer | Gets properties used to configure streaming or direct DMA. |
| DeviceInstantaneousBandwidth | Gets or sets the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration. |
| DigitalEqualizationEnabled | Gets or sets whether to enable digital equalization. When enabled, NI-RFSG equalizes the IF data to correct variations in the response of the upconverter. |
| DigitalGain | Gets or sets the digital gain, in decibels. |
| DigitalPatternEnabled | Gets or sets whether to enable digital pattern on the arbitrary waveform generator (AWG) module. |
| GenerationMode | Gets or sets whether to generate a continuous wave (CW) signal, the arb waveform specified by SelectedWaveform, or the script specified by SelectedScriptName, on calling Initiate. |
| InterpolationDelay | Gets or sets the delay to apply to the I/Q waveform. |
| IQRate | Gets or sets the I/Q rate of the arbitrary waveform in samples per second (S/s). |
| IQSwapEnabled | Gets or sets whether to enable inverse phase rotation of the I/Q signal by swapping the I and Q inputs. |
| IsWaveformRepeatCountFinite | Gets or sets the repetition mode of a waveform when you set the Generation Mode property to Arb Waveform. |
| MemorySize | Gets the total amount of memory, in bytes, on the signal generator. |
| OutputPort | Gets or sets the connector(s) to generate the signal. |
| OverflowErrorReporting | Gets or sets error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform. |
| PhaseContinuityEnabled | Gets or sets whether the driver maintains phase continuity in the arbitrary waveforms. |
| Power | Gets the output power, in dBm, from the arbitrary waveform generator (AWG) module. |
| PreFilterGain | Gets or sets the arbitrary waveform generator (AWG) prefilter gain, in dB. |
| PulseShaping | Gets the PulseShaping sub-object used to configure the arbitrary waveform generator (AWG) filter. |
| RelativeDelay | Gets or sets the delay, in seconds, to apply to the I/Q waveform. |
| Scripting | Gets the Scripting sub-object used for scripting. |
| SelectedWaveform | Gets or sets the selected waveform from the pool of available waveforms. |
| SignalBandwidth | Gets or sets the bandwidth, in hertz (Hz), of the arbitrary signal. |
| WaveformCapabilities | Gets the WaveformCapabilities sub-object that queries the arbitrary waveform capabilities. |
| WaveformRepeatCount | Gets or sets the repeat count of a waveform when you set the Generation Mode property to Arb Waveform and the repeat count is finite. |
| Waveforms | Gets properties used to configure Arb Waveform. A waveform name can be passed using the indexer NationalInstruments.ModularInstruments.NIRfsg.RfsgArbWaveformCollection.this[string]. |
| WaveformSoftwareScalingFactor | Gets or sets how much to scale the data before writing with WriteWaveform. |
| WriteWaveformNormalization | Sets or gets the value to perform the normalization on a waveform. ///. |
Methods
| Name | Description |
|---|---|
| AllocateWaveform(string, int) | Allocates onboard memory space for the waveform. |
| CheckIfWaveformExists(string) | Checks whether the waveform that you specify as waveformName exists. |
| ClearAllWaveforms() | Deletes all waveforms and scripts defined currently. |
| ClearWaveform(string) | Deletes the specified waveform from the pool of waveforms defined currently. |
| GetAllNamedWaveformNames(ref string[]) | Return names of the waveforms present in the memory. |
| GetAllScriptNames(ref string[]) | Return names of the scripts present in the memory. |
| GetScript(string, ref string) | Return script associated with scriptName present in the memory. |
| ReadAndDownloadWaveformFromFileTdms(string, string, UInt32) | Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators. /summary> |
| SetArbWaveformNextWritePosition(string, RfsgArbWaveformRelativeWritePosition, int) | Configures the start position to use the write a waveform with the next call to the WriteWaveform methods. |
| WriteWaveform(string, ComplexDouble[], bool) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory. |
| WriteWaveform(string, float[], float[]) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |
| WriteWaveform(string, double[], double[]) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |
| WriteWaveform(string, float[], float[], bool) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |
| WriteWaveform(string, double[], double[], bool) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |
| WriteWaveform(string, ComplexSingle[], bool) | Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. |
| WriteWaveform(string, ComplexInt16[]) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory. |
| WriteWaveform(string, ComplexSingle[]) | Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. |
| WriteWaveform(string, ComplexDouble[]) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory. |
| WriteWaveform(string, ComplexWaveform< ComplexSingle >) | Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. |
| WriteWaveform(string, ComplexWaveform< ComplexDouble >) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory. |
| WriteWaveform(string, ComplexWaveform< ComplexInt16 >) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory. |
| WriteWaveform< T >(string, ComplexWaveform< T >) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |
| WriteWaveform< T >(string, T[]) | Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory. |