RfsgDriverUtility Class
- Updated2025-10-14
- 2 minute(s) read
Represents the methods that provide a basic set of utility operations.
Derives from
- RfsgSubObject
- IIviDriverUtility
Syntax
Namespace: NationalInstruments.ModularInstruments.NIRfsg
public class RfsgDriverUtility : RfsgSubObject, IIviDriverUtility
Remarks
For more information, refer to the NI-RFSG Instrument Driver Programming Flow topic in the NI RF Signal Generators Help.
Methods
| Name | Description |
|---|---|
| Commit() | Asserts the configured hardware parameters. |
| Disable() | Places the instrument in a quiescent state as quickly as possible. |
| ErrorQuery() | Reads an error code and an error message from the instrument error queue. |
| ExportSignal(RfsgSignalType, RfsgSignalIdentifier, RfsgOutputTerminal) | Routes signals (triggers, clocks, and events) to a specified output terminal. The NI-RFSG device must be in the Configuration state before you call this function. You can clear a previously routed signal by exporting the signal to "" (empty string). |
| GetMaxSettablePower(out double) | Return the maximum settable output power for a given configuration. |
| Lock(Ivi.Driver.PrecisionTimeSpan) | Obtains a multithread lock on the instrument session and specifies the maximum amount of time to wait to acquire the lock. |
| Lock() | Obtains a multithread lock on the instrument session. |
| PerformPowerSearch() | Performs a power search if you set the AlcControl property to Disable. Calling this method disables modulation for a short time while the device levels the output signal. |
| PerformThermalCorrection() | Corrects any signal drift due to environmental temperature variation while generating the same signal for extended periods of time without a parameter change. |
| Reset() | Resets all properties to their default values and moves the NI-RFSG device to the Configuration state. |
| ResetAttribute(PropertyInfo) | Resets the property to its default value. |
| ResetAttribute(string, PropertyInfo) | Resets the channel specific property to its default value. |
| ResetAttribute(string, int) | Resets the property to its default value. |
| ResetDevice() | Performs a hard reset on the device by performing a set of actions. |
| ResetWithDefaults() | Performs a software reset of the device, returning it to the default state and applying any initial default settings from the Configuration state. |
| ResetWithOptions(RfsgResetStepsToOmit) | Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes. |
| RevisionQuery() | Returns the revision numbers of the NI-RFSG driver and the instrument firmware. |
| SelfCalibrate() | Performs an internal self-calibration on the device. This method is obsolete, use SelfCalibrate method instead. |
| SelfTest() | Performs a self-test on the NI-RFSG device and returns the test results. |
| WaitUntilSettled(int) | Waits until the RF output signal has settled. |