NIRfsg Namespace

Table of Contents

NIRfsg Class

  • Updated2025-05-22
  • 6 minute(s) read
NIRfsg Class

NIRfsg Class

Defines a root class that identifies and controls the instrument session.

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIRfsgNIRfsg

Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx45 (in NationalInstruments.ModularInstruments.NIRfsg.Fx45.dll) Version: 2025

Syntax

public sealed class NIRfsg : IDisposable, 
	IServiceProvider, IIviDriver, ITClockSynchronizableDevice
Public NotInheritable Class NIRfsg
	Implements IDisposable, IServiceProvider, IIviDriver, ITClockSynchronizableDevice

The NIRfsg type exposes the following members.

Constructors

 NameDescription
Public methodNIRfsg(IntPtr) Creates a new instrument driver session from an existing instrument handle.
Public methodNIRfsg(String, Boolean, Boolean) Creates a new instrument driver session.
Public methodNIRfsg(String, Boolean, Boolean, String) Creates a new instrument driver session and sets the initial state of session properties.
Top

Properties

 NameDescription
Public propertyArb Gets the Arb sub-object used to configure the arbitrary waveform generator (AWG).
Public propertyArbSampleClock Gets the ArbSampleClock sub-object used to configure the sample clock.
Public propertyBasicConfigurationList Gets the BasicConfigurationList sub-object used to work with the configuration lists.
Public propertyCalibration Gets the Calibration sub-object that allows calibration of the NI-RFSG.
Public propertyDeembedding Gets the Deembedding sub-object used to configure Deembedding. A port can be passed using the indexer ItemString.
Public propertyDeviceCharacteristics Gets the DeviceCharacteristics sub-object used to get device characteristics such as DeviceTemperature, ModuleRevision, and LOTemperature. An active channel can be passed using the indexer ItemString.
Public propertyDeviceEvents Gets the DeviceEvents sub-object used to configure the NI-RFSG events that can be exported.
Public propertyDriverIdentityObsolete.
Gets the DriverIdentity sub-object that provides identity and version information about the NI-RFSG instrument driver.
Public propertyDriverOperation Gets the DriverOperation sub-object that affect operation of the NI-RFSG instrument driver.
Public propertyDriverUtilityObsolete.
Gets the DriverUtility sub-object applicable to driver utility operations such as SelfCalibrate, Reset, and Commit.
Public propertyFrequencyReference Gets the FrequencyReference sub-object used to configure the Reference clock signal.
Public propertyIdentity Gets the Identity sub-object that provides identity and version information about the NI-RFSG instrument driver.
Public propertyIQImpairments Gets the IQImpairments sub-object used to apply I/Q impairments such as GainImbalance and Skew.
Public propertyIQOutPort Gets the IQOutPort sub-object used to configure the I/Q OUT port. An active channel can be passed using the indexer ItemString.
Public propertyIsDisposed Gets whether the driver session is disposed.
Public propertyModulation Gets the Modulation sub-object used to configure digital and analog modulation parameters.
Public propertyRF Gets the RF sub-object used to access fundamental properties for RF characteristics.
Public propertySignalPath Gets the SignalPath sub-object used to configure Signal Path.
Public propertyTriggers Gets the Triggers sub-object used to configure the NI-RFSG triggers.
Public propertyUtility Gets the Utility sub-object applicable to driver utility operations such as SelfCalibrate, Reset, and Commit.
Top

Methods

 NameDescription
Public methodAbort Stops signal generation.
Public methodCheckGenerationStatus Checks the status of signal generation.
Public methodClose Aborts any signal generation in progress and destroys the instrument driver session.
Public methodDangerousGetInstrumentHandleObsolete.
Returns the value of the underlying instrument handle.
Public methodDispose Closes the specified session and deallocates the reserved resources, if not already disposed.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Calls the Dispose method to close the specified session and deallocate the reserved resources, if not already disposed.
(Overrides ObjectFinalize)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetInstrumentHandle Gets the SafeHandle to the NIRfsg instrument session.
Public methodGetService Returns an object that represents a service provided by NIRfsg.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitiate Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodStatic memberVstSelfCalibrate Performs an internal self-calibration on the device and associated modules that support self-calibration. If the calibration is successful, new calibration data and constants are stored in the onboard nonvolatile memory of the module. NI recommends that no external signals are present on the RF In port while the calibration is taking place. Refer to the specification document for your device for more information on self-calibration.
Top

Remarks

To interact with the NI-RFSG, you must create an instance of this class.

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

See Also

Log in to get a better experience