ni-rfsg-dotnet-api-ref_doc

Table of Contents

RfsgArb Class

  • Updated2024-05-08
  • 8 minute(s) read
RfsgArb Class

RfsgArb Class

Provides methods and properties used to configure the arbitrary waveform generator (AWG).

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIRfsgRfsgSubObject
    NationalInstruments.ModularInstruments.NIRfsgRfsgArb

Namespace:  NationalInstruments.ModularInstruments.NIRfsg
Assembly:  NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022

Syntax

public sealed class RfsgArb : RfsgSubObject
Public NotInheritable Class RfsgArb
	Inherits RfsgSubObject

The RfsgArb type exposes the following members.

Properties

  NameDescription
Public propertyAbsoluteDelay
Gets or sets the sub-Sample Clock delay, in seconds, to apply to the I/Q waveform.
Public propertyBurstDetection
Gets properties used to configure burst detection of waveform.
Public propertyCarrierFrequency
Gets or sets the carrier frequency, in Hertz (Hz), of the signal generated by the arbitrary waveform generator (AWG) module.
Public propertyDataTransfer
Gets properties used to configure streaming or direct DMA.
Public propertyDeviceInstantaneousBandwidth
Gets or sets the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration.
Public propertyDigitalEqualizationEnabled
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.
Public propertyDigitalGain
Gets or sets the digital gain, in decibels.
Public propertyDigitalPatternEnabled
Gets or sets whether to enable digital pattern on the arbitrary waveform generator (AWG) module.
Public propertyGenerationMode
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.
Public propertyInterpolationDelay
Gets or sets the delay to apply to the I/Q waveform.
Public propertyIQRate
Gets or sets the I/Q rate of the arbitrary waveform in samples per second (S/s).
Public propertyIQSwapEnabled
Gets or sets whether to enable inverse phase rotation of the I/Q signal by swapping the I and Q inputs.
Public propertyIsWaveformRepeatCountFinite
Gets or sets the repetition mode of a waveform when you set the Generation Mode property to Arb Waveform.
Public propertyMemorySize
Gets the total amount of memory, in bytes, on the signal generator.
Public propertyOutputPort
Gets or sets the connector(s) to generate the signal.
Public propertyOverflowErrorReporting
Gets or sets error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform.
Public propertyPhaseContinuityEnabled
Gets or sets whether the driver maintains phase continuity in the arbitrary waveforms.
Public propertyPower
Gets the output power, in dBm, from the arbitrary waveform generator (AWG) module.
Public propertyPreFilterGain
Gets or sets the arbitrary waveform generator (AWG) prefilter gain, in dB.
Public propertyPulseShaping
Gets the PulseShaping sub-object used to configure the arbitrary waveform generator (AWG) filter.
Public propertyRelativeDelay
Gets or sets the delay, in seconds, to apply to the I/Q waveform.
Public propertyScripting
Gets the Scripting sub-object used for scripting.
Public propertySelectedWaveform
Gets or sets the selected waveform from the pool of available waveforms.
Public propertySignalBandwidth
Gets or sets the bandwidth, in hertz (Hz), of the arbitrary signal.
Public propertyWaveformCapabilities
Gets the WaveformCapabilities sub-object that queries the arbitrary waveform capabilities.
Public propertyWaveformRepeatCount
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.
Public propertyWaveforms
Gets properties used to configure Arb Waveform. A waveform name can be passed using the indexer ItemString.
Public propertyWaveformSoftwareScalingFactor
Gets or sets how much to scale the data before writing with WriteWaveform(String, Double, Double).
Public propertyWriteWaveformNormalization
Sets or gets the value to perform the normalization on a waveform. ///
Top

Methods

  NameDescription
Public methodAllocateWaveform
Allocates onboard memory space for the waveform.
Public methodCheckIfWaveformExists
Checks whether the waveform that you specify as waveformName exists.
Public methodClearAllWaveforms
Deletes all waveforms and scripts defined currently.
Public methodClearWaveform
Deletes the specified waveform from the pool of waveforms defined currently.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodReadAndDownloadWaveformFromFileTdms
Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.
Public methodSetArbWaveformNextWritePosition
Configures the start position to use the write a waveform with the next call to the WriteWaveform methods.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteWaveform(String, ComplexDouble)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory.
Public methodWriteWaveform(String, ComplexInt16)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory.
Public methodWriteWaveform(String, ComplexSingle)
Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory.
Public methodWriteWaveform(String, ComplexWaveformComplexDouble)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory.
Public methodWriteWaveform(String, ComplexWaveformComplexInt16)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory.
Public methodWriteWaveform(String, ComplexWaveformComplexSingle)
Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory.
Public methodWriteWaveform(String, ComplexDouble, Boolean)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in the onboard memory.
Public methodWriteWaveform(String, ComplexSingle, Boolean)
Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory.
Public methodWriteWaveform(String, Double, Double)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Public methodWriteWaveform(String, Single, Single)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Public methodWriteWaveform(String, Double, Double, Boolean)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Public methodWriteWaveform(String, Single, Single, Boolean)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Public methodWriteWaveformT(String, ComplexWaveformT)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Public methodWriteWaveformT(String, T)
Writes an arbitrary waveform to the NI-RFSG, starting from the position of the last data written in onboard memory.
Top

Remarks

For more information, refer to the NI-RFSG Instrument Driver Programming Flow topic in the NI RF Signal Generators Help.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Log in to get a better experience