NationalInstruments.ModularInstruments.NIRfsg Namespace
- Updated2025-02-03
- 16 minute(s) read
National
The NI-RFSG .NET class library can be used to control NI RF signal generators through the NI-RFSG instrument driver. This library includes methods and properties that exercise the functionality of the NI-RFSG hardware, including configuration and acquisition of waveforms.
Refer to Using the Measurement Studio NI-RFSG .NET Library, Basic Usage, or Mapping the NI-RFSG .NET API to the NI-RFSG C API for more information.
Note:Integrated help for IVI Foundation interfaces is not provided. You must use the IntelliSense help.
Classes
| Class | Description | |
|---|---|---|
 | NIRfsg | Defines a root class that identifies and controls the instrument session. |
| RfsgAnalogModulation | Provides properties used to configure analog modulation. |
| RfsgArb | Provides methods and properties used to configure the arbitrary waveform generator (AWG). |
| RfsgArbMarkerAttributes | Provides the methods for configuring arb marker attributes. |
| RfsgArbMarkerCollection | Represents a collection of Arb Marker events. |
| RfsgArbSampleClock | Provides properties used to configure the Arb Sample clock. |
| RfsgArbSampleClockSource | Represents the source for the arbitrary waveform generator (AWG) Sample clock. |
| RfsgArbWaveformAttributes | Provides the methods and attributes for configuring waveform properties. |
| RfsgArbWaveformCollection | Represents a collection of Arb waveform attributes. |
| RfsgBasicConfigurationList | Provides the methods and properties used to work with configuration lists. |
| RfsgBurstDetection | Provides methods and properties used to configure the burst properties of a waveform. |
| RfsgCalibration | Provides the properties to calibrate NI-RFSG device. |
| RfsgChannelBasedDeembedding | Represents the channel-based properties and methods used to configure Deembedding. |
| RfsgChannelBasedDeviceCharacteristics | Represents the channel-based properties related to device information. |
| RfsgChannelBasedIQOutPort | Provides channel based methods and properties used to configure the I/Q OUT port. |
| RfsgChannelBasedLO | Represents all the fundamental properties used to configure channel based LO. |
| RfsgConfigurationListStepTrigger | Provides the method and properties used to configure the Configuration List Step trigger. |
| RfsgConfigurationListStepTriggerExportedOutputTerminal | Represents the destination terminal for RfsgConfigurationListStepTrigger. |
| RfsgConfigurationSettledEvent | Provides the properties to configure Configuration Settled events. |
| RfsgConfigurationSettledEventExportedOutputTerminal | Gets the destination terminal for RfsgDoneEvent. |
| RfsgDataTransfer | Provides the properties used to configure streaming or direct DMA. |
| RfsgDataTransferAdvanced | Provides the properties used to configure advanced properties for RfsgDataTransfer. |
| RfsgDeembedding | Represents the properties and methods used to configure Deembedding. |
| RfsgDeviceCharacteristics | Represents the properties related to device information. |
| RfsgDeviceCharactersticsOptions | Provides the properties to configure device characteristics. |
| RfsgDeviceEvents | Provides the properties used to configure NI-RFSG events that can be exported. |
| RfsgDigitalEdgeConfigurationListStepTrigger | Provides the methods and properties used to configure the Configuration List Step trigger for digital edge triggering, if RfsgConfigurationListStepTrigger is set to DigitalEdge. |
| RfsgDigitalEdgeConfigurationListStepTriggerSource | Represents the source terminal for RfsgDigitalEdgeConfigurationListStepTrigger. |
| RfsgDigitalEdgeScriptTrigger | Provides the method and properties used to configure Script trigger for digital edge triggering, if the selected RfsgScriptTriggerType is DigitalEdge. |
| RfsgDigitalEdgeScriptTriggerSource | Represents the source terminal for RfsgDigitalEdgeStartTrigger. |
| RfsgDigitalEdgeStartTrigger | Provides the method and properties used to configure Start trigger for digital edge triggering, if RfsgStartTriggerType is DigitalEdge. |
| RfsgDigitalEdgeStartTriggerSource | Represents the source terminal for RfsgDigitalEdgeStartTrigger. |
| RfsgDigitalLevelScriptTrigger | Provides the methods and properties used to configure the specified Script trigger for digital level triggering, if the selected RfsgScriptTriggerType is DigitalLevel. |
| RfsgDigitalLevelScriptTriggerSource | Represents the source terminal for RfsgDigitalLevelScriptTrigger. |
| RfsgDigitalModulation | Provides the methods and properties used to configure digital modulation. |
| RfsgDirectDma | Obsolete. Provides the properties used to configure direct DMA to transfer waveform data to the RF signal generator onboard memory at rates well beyond the typical 5 MB/s to 30 MB/s range. |
| RfsgDoneEvent | Provides the properties used to configure Done event. |
| RfsgDoneEventExportedOutputTerminal | Represents the destination terminal for RfsgDoneEvent. |
| RfsgDriverIdentity | Represents the methods and properties that provide identity and version information about the NI-RFSG driver. |
| RfsgDriverLock | Represents the methods to unlock a driver lock. |
| RfsgDriverOperation | Represents the methods and properties that provide driver operation functionality. |
| RfsgDriverUtility | Represents the methods that provide a basic set of utility operations. |
| RfsgExportedPulseModulationEventOutputTerminal | Represents the output terminal for pulse modulation. |
| RfsgFrequencyReference | Provides the methods and properties used to configure the Frequency Reference clock and the PxiChassisClock10. |
| RfsgFrequencyReferenceExportedOutputTerminal | Represents the destination terminal of RfsgFrequencyReference. |
| RfsgFrequencyReferenceSource | Represents the source of RfsgFrequencyReference. |
| RfsgIQImpairment | Provides the properties to apply I/Q impairments. |
| RfsgIQOutPort | Provides methods and properties used to configure the I/Q OUT Port. |
| RfsgLocalOscillatorSource | Represents the source for Local Oscillator. |
| RfsgMarkerEvent | Represents the channel-based properties related to Marker events. |
| RfsgMarkerEventCollection | Represents a collection of Marker events. |
| RfsgMarkerEventExportedOutputTerminal | Represents the destination terminal for RfsgMarkerEvent. |
| RfsgModulation | Provides the properties used to configure modulation. |
| RfsgOutputTerminal | Specifies the terminal where the signal is exported. You can choose not to export any signal. |
| RfsgPulseModulationSource | Represents the source terminal that pulse modulation triggers off of. |
| RfsgPulseShaping | Provides the properties used to configure the arbitrary waveform generator (AWG) filter. |
| RfsgPxiChassisClock10Source | Represents the source for the PXI chassis clock. |
| RfsgRF | Represents all the fundamental properties and method for the RF. |
| RfsgRFAdvanced | Represents the advanced properties that relate only to the RF. |
| RfsgRFBlankingSource |
Represents the marker event at which RF blanking occurs.
For PXIe-5830/5831/5832, the RF Blanking reserves a PXI trigger line. If you are calling any RfsgDriverUtility.ResetDevice or RfsaDriverUtility.ResetDevice on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call RfsgDriverUtility.ResetWithOptions or RfsaDriverUtility.ResetWithOptions. Select Routes in the stepsToOmit parameter. |
| RfsgRFLocalOscillator | Represents all the fundamental properties for the RF local oscillator. |
| RfsgRFWaveformAttributes | Provides the properties used to configure RF blanking. |
| RfsgRFWaveformCollection | Represents a collection attributes for configuring waveform properties. |
| RfsgScripting | Provides the methods and properties for scripting. |
| RfsgScriptTrigger | Represents the channel-based methods and properties used to configure the Script trigger. |
| RfsgScriptTriggerCollection | Represents a collection of RfsgScriptTrigger. |
| RfsgScriptTriggerExportedOutputTerminal | Represents the destination terminal of RfsgScriptTrigger. |
| RfsgSelfCalibration | Provides the methods and properties to perform self-calibration and to query data related to self-calibration. |
| RfsgSignalIdentifier | Specifies which instance of the selected signal to export. This parameter is useful when you set the RfsgSignalType to ScriptTrigger or MarkerEvent. Otherwise, set this parameter to None. |
| RfsgSignalPath | Represents the properties and methods used to configure SignalPath. |
| RfsgStartedEvent | Provides the properties to configure Started events. |
| RfsgStartedEventExportedOutputTerminal | Represents the destination terminal of RfsgStartedEvent. |
| RfsgStartTrigger | Provides the properties used to configure the Start trigger. |
| RfsgStartTriggerExportedOutputTerminal | Represents the destination terminal of RfsgStartTrigger. |
| RfsgStreaming | Represents properties used to configure streaming of waveform data. |
| RfsgSubObject | Represents members that are common to all sub-object NI-Rfsg classes. |
| RfsgSynchronizedSampleClock | Provides the properties used to synchronize the Sample Clock. |
| RfsgSynchronizedSampleClockDistributionLine | Represents the distribution line for Synchronized Sample Clock signal. |
| RfsgSynchronizedScriptTrigger | Provides the properties used to synchronize the Script Trigger. |
| RfsgSynchronizedScriptTriggerDistributionLine | Represents the distribution line for synchronized script triggers. |
| RfsgSynchronizedStartTrigger | Provides the properties used to synchronize the Start trigger. |
| RfsgSynchronizedStartTriggerDistributionLine | Represents the distribution line for synchronized start trigger. |
| RfsgTimerEvent | Provides the properties used to configure the Timer events. |
| RfsgTriggers | Provides the properties used to configure NI-RFSG triggers. |
| RfsgUpconverter | Represents properties that relate only to the RF upconverter. |
| RfsgWarning | Represents the properties to return various device warnings. |
| RfsgWarningEventArgs | Represents properties under Warning Event Args. |
| RfsgWaveformCapabilities | Represents properties that query the arbitrary waveform capabilities. |
Structures
| Structure | Description | |
|---|---|---|
 | RfsgErrorQueryResult | Represents the result of an error query. |
| RfsgRevisionQueryResult | Represents the driver revision. |
| RfsgSelfTestResult | Represents the result of the SelfTest. |
Enumerations
| Enumeration | Description | |
|---|---|---|
 | RfsgAlcControl | Specifies whether to enable or disable the automatic leveling control (ALC). |
| RfsgAmplificationPath | Specifies whether to use the high power path or low harmonic path. |
| RfsgAnalogModulationFMBand | Specifies the FM band to use in Analog modulation. |
| RfsgAnalogModulationFMNarrowbandIntegrator | Specifies the values for narrowband frequency modulation (FM) range. |
| RfsgAnalogModulationPMMode | Specifies whether to use high deviation mode or low phase noise mode. |
| RfsgAnalogModulationType | Specifies the analog modulation format to use. |
| RfsgAnalogModulationWaveformType | Specifies the type of waveform to use as the message signal for analog modulation. |
| RfsgArbWaveformRelativeWritePosition | Specifies the reference position in the waveform. The position and offset together determine where to start loading data into the waveform. |
| RfsgAutoPowerSearch | Specifies whether to enable or disable the automatic power search. |
| RfsgBasicConfigurationListRepeat | Specifies whether the configuration list runs continuously. |
| RfsgBurstDetectionEnabled |
Enables the detection of burst start and burst stop locations in the waveform.
You can read the detected burst start and burst stop locations using
GetWaveformBurstStartLocations and GetWaveformBurstStopLocations methods respectively.
When you download a waveform using ReadAndDownloadWaveformFromFileTdms and if RFBlankingproperty is enabled, you must set the RfsgBurstDetectionEnabled property to Disable. For PXIe-5830/5831/5832, the RF Blanking reserves a PXI trigger line. If you are calling any RfsgDriverUtility.ResetDevice or RfsaDriverUtility.ResetDevice on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call RfsgDriverUtility.ResetWithOptions or RfsaDriverUtility.ResetWithOptions. Select Routes in the stepsToOmit parameter. |
| RfsgBurstDetectionMode | Specifies the algorithm that NI-RFSG uses to detect the burst start and burst stop locations in the waveform when burst detection is enabled using the RfsgBurstDetectionEnabled property. When you set RfsgBurstDetectionMode to Auto, NI-RFSG automatically detects the burst start and burst stop locations by analyzing the waveform. To fine-tune the burst detection process parameters yourself, you can set this attribute to Manual and specify the burst detection parameters using the Minimum Quiet Time, Power Threshold, and Minimum Burst Time methods. |
| RfsgConfigurationListProperties | Specifies the configuration list properties that the user can change between configuration list steps. See CreateConfigurationList(String, RfsgConfigurationListProperties, Boolean). |
| RfsgConfigurationListStepTriggerType | Specifies the type of trigger to use as the Configuration List Step trigger. |
| RfsgDeembeddingType | Specifies the type of de-embedding to apply to measurements on the specified port. |
| RfsgDeviceModule | Specifies the hardware module to use for self-calibration. |
| RfsgDigitalModulationType | Specifies the digital modulation format to use. |
| RfsgDigitalModulationWaveformType | Specifies the type of waveform to use as the message signal for digital modulation. |
| RfsgFilterType | Specifies the pulse-shaping filter type for the finite-impulse response (FIR) filter. |
| RfsgGenerationStatus | Specifies the status of signal generation. See CheckGenerationStatus. |
| RfsgIQOffsetUnits |
Specifies the units of the IOffset property and the QOffset property.
For any devices except PXIe-5820, if the RfsgIQOffsetUnits method is set to Volts, a 0.1 I offset results in a 0.1 V offset in the output. For PXIe-5820 devices, 0.1 I offset results in a 10% offset in the output. |
| RfsgLinearInterpolationFormat | Specifies the format of parameters to interpolate. |
| RfsgLoadConfigurationsFromFileLoadOptions | Specifies the configurations to skip to reset while loading configurations from a file. |
| RfsgLoadConfigurationsFromFileResetOptions | Specifies the configurations to skip while loading from a file. |
| RfsgLoopBandwidth | Specifies the loop bandwidth of the tuning phase-locked loop (PLL). |
| RfsgLOOutExportConfigureFromRfsa | Specifies whether to allow NI-RFSA to control the NI-RFSG LO out export. |
| RfsgLOPllFractionalModeEnabled | Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). |
| RfsgMarkerEventOutputBehavior | Specifies the output behavior for the Marker Event. |
| RfsgMarkerEventPulseWidthUnits | Specifies the pulse width units for the Marker Event. |
| RfsgMarkerEventToggleInitialState | Specifies the initial state for the Marker Event when you set the OutputBehavior property to Toggle. |
| RfsgModule | Specifies the module in the NI-RFSG device. |
| RfsgOnboardSampleClockMode | Specifies the sample clock mode on the arbitrary waveform generator (AWG) module. |
| RfsgOutputPort | Specifies the connector(s) to generate the signal. |
| RfsgOverflowErrorReporting | Specifies whether NI-RFSG returns a warning when an OSP overflow occurs. |
| RfsgPeakPowerAdjustmentInheritance | Determines the inheritance behavior of the PeakPowerAdjustment property when a script inherits values from specified waveforms. |
| RfsgPhaseContinuityEnabled | Specifies whether the driver maintains phase continuity in the arbitrary waveforms. |
| RfsgPulseModulationMode | Specifies the Pulse modulation mode to use. |
| RfsgReferencePllBandwidth | Specifies the loop bandwidth of the reference phase-locked loops (PLL). |
| RfsgResetStepsToOmit | Specifies a list of steps to skip during the reset process. |
| RfsgRFBlanking | Enables or disables RF blanking. |
| RfsgRFFrequencySettlingUnits | Specifies the interpretation of the value passed to the FrequencySettlingTime property. |
| RfsgRFInLOExportEnabled | Specifies whether to enable the RF IN LO OUT terminal on the PXIe-5840. |
| RfsgRFPortType | Specifies the port type of the daisy-chained PXIe-5840. |
| RfsgRFPowerLevelType | Specifies how NI-RFSG interprets the value of the PowerLevel property. |
| RfsgScriptTriggerType | Specifies the Script trigger type. |
| RfsgSelfCalibrationSteps | Specifies which calibration steps to skip as part of the self-calibration process. |
| RfsgSignalType | Specifies the type of signal to route. |
| RfsgSParameterOrientation | Specifies the orientation of the data in the S2P file relative to the port on the DUT port. |
| RfsgStartTriggerType | Specifies the Start trigger types. |
| RfsgTerminalConfiguration | Specifies whether to use the I/Q OUT port for Differential configuration or Single-Ended configuration. |
| RfsgTriggerEdge | Specifies the transition of the signal from one discrete level to another. |
| RfsgTriggerLevel | Specifies the active level for the Script trigger. |
| RfsgWaveformGenerationMode | Specifies type of signal to generate, on calling the Initiate method. |
| RfsgWriteWaveformNormalization |
Sets or gets the value to perform the normalization on a waveform.
You can not set RfsgWriteWaveformNormalization and RfsgRFPowerLevelType methods at the same time. |
| RfsgYigMainCoilDriveType | Adjusts the dynamics of the current driving the YIG main coil. |
| UpconverterFrequencyOffsetMode | Specifies whether NI-RFSG automatically selects the upconverter frequency offset. |