NIRfsg Class
- Updated2024-05-08
- 6 minute(s) read
NIRfsg Class
Defines a root class that identifies and controls the instrument session.
Inheritance Hierarchy
Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022
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
| Name | Description | |
|---|---|---|
 | NIRfsg(IntPtr) |
Creates a new instrument driver session from an existing instrument handle.
|
| NIRfsg(String, Boolean, Boolean) |
Creates a new instrument driver session.
|
| NIRfsg(String, Boolean, Boolean, String) |
Creates a new instrument driver session and sets the initial state of session properties. |
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 ItemString.
|
| 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 ItemString.
|
| DeviceEvents |
Gets the DeviceEvents sub-object used to configure the NI-RFSG events that can be exported.
|
| DriverIdentity | Obsolete.
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 | Obsolete.
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 | |
| IQOutPort |
Gets the IQOutPort sub-object used to configure the I/Q OUT port. An active channel can be passed using the indexer ItemString.
|
| 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.
|
| Equals | (Inherited from Object.) |
 | Finalize |
Calls the Dispose method to close the specified session and deallocate the reserved resources, if not already disposed.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetInstrumentHandle |
Gets the SafeHandle to the NIRfsg instrument session.
|
| GetService |
Returns an object that represents a service provided by NIRfsg.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initiate |
Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
 | VstSelfCalibrate |
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.
|
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.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.