NIRfsg Class
- Updated2025-10-14
- 3 minute(s) read
Defines a root class that identifies and controls the instrument session.
Derives from
- IDisposable
- IServiceProvider
- IIviDriver
- ITClockSynchronizableDevice
Syntax
Namespace: NationalInstruments.ModularInstruments.NIRfsg
public class NIRfsg : IDisposable, IServiceProvider, IIviDriver, ITClockSynchronizableDevice
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.
Constructors
| Name | Description |
|---|---|
| NIRfsg(string, bool, bool) | Creates a new instrument driver session. |
| NIRfsg(string, bool, bool, string) | Creates a new instrument driver session and sets the initial state of session properties. |
| NIRfsg(IntPtr) | Creates a new instrument driver session from an existing instrument handle. |
Properties
| Name | Description |
|---|---|
| Arb | Gets the Arb sub-object used to configure the arbitrary waveform generator (AWG). |
| ArbSampleClock | Gets the ArbSampleClock sub-object used to configure the sample clock. |
| BasicConfigurationList | Gets the BasicConfigurationList sub-object used to work with the configuration lists. |
| Calibration | Gets the Calibration sub-object that allows calibration of the NI-RFSG. |
| Deembedding | Gets the Deembedding sub-object used to configure Deembedding. A port can be passed using the indexer NationalInstruments.ModularInstruments.NIRfsg.RfsgDeembedding.this[string]. |
| DeviceCharacteristics | 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 NationalInstruments.ModularInstruments.NIRfsg.RfsgDeviceCharacteristics.this[string]. |
| DeviceEvents | Gets the DeviceEvents sub-object used to configure the NI-RFSG events that can be exported. |
| DriverIdentity | Gets the DriverIdentity sub-object that provides identity and version information about the NI-RFSG instrument driver. |
| DriverOperation | Gets the DriverOperation sub-object that affect operation of the NI-RFSG instrument driver. |
| DriverUtility | Gets the DriverUtility sub-object applicable to driver utility operations such as SelfCalibrate, Reset, and Commit. |
| FrequencyReference | Gets the FrequencyReference sub-object used to configure the Reference clock signal. |
| Identity | Gets the Identity sub-object that provides identity and version information about the NI-RFSG instrument driver. |
| IQImpairments | Gets the IQImpairments sub-object used to apply I/Q impairments such as GainImbalance and Skew. |
| IQOutPort | Gets the IQOutPort sub-object used to configure the I/Q OUT port. An active channel can be passed using the indexer NationalInstruments.ModularInstruments.NIRfsg.RfsgIQOutPort.this[string]. |
| IsDisposed | Gets whether the driver session is disposed. |
| Modulation | Gets the Modulation sub-object used to configure digital and analog modulation parameters. |
| RF | Gets the RF sub-object used to access fundamental properties for RF characteristics. |
| SignalPath | Gets the SignalPath sub-object used to configure Signal Path. |
| Triggers | Gets the Triggers sub-object used to configure the NI-RFSG triggers. |
| Utility | Gets the Utility sub-object applicable to driver utility operations such as SelfCalibrate, Reset, and Commit. |
Methods
| Name | Description |
|---|---|
| Abort() | Stops signal generation. |
| CheckGenerationStatus() | Checks the status of signal generation. |
| Close() | Aborts any signal generation in progress and destroys the instrument driver session. |
| Dispose() | Closes the specified session and deallocates the reserved resources, if not already disposed. |
| GetInstrumentHandle() | Gets the System.Runtime.InteropServices.SafeHandle to the NIRfsg instrument session. |
| GetService(Type) | Returns an object that represents a service provided by NIRfsg. |
| Initiate() | Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. |
| Finalize() | Calls the Dispose method to close the specified session and deallocate the reserved resources, if not already disposed. |
| VstSelfCalibrate(string) | 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. |