RfsgDriverUtility Class
- Updated2024-05-08
- 4 minute(s) read
RfsgDriverUtility Class
Represents the methods that provide a basic set of utility operations.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIRfsgRfsgSubObject
NationalInstruments.ModularInstruments.NIRfsgRfsgDriverUtility
NationalInstruments.ModularInstruments.NIRfsgRfsgSubObject
NationalInstruments.ModularInstruments.NIRfsgRfsgDriverUtility
Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022
Syntax
public sealed class RfsgDriverUtility : RfsgSubObject, IIviDriverUtility
Public NotInheritable Class RfsgDriverUtility Inherits RfsgSubObject Implements IIviDriverUtility
The RfsgDriverUtility type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Commit |
Asserts the configured hardware parameters.
|
| Disable |
Places the instrument in a quiescent state as quickly as possible.
|
| Equals | (Inherited from Object.) |
| ErrorQuery |
Reads an error code and an error message from the instrument error queue.
|
| ExportSignal |
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).
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Lock |
Obtains a multithread lock on the instrument session.
|
| Lock(PrecisionTimeSpan) |
Obtains a multithread lock on the instrument session and specifies the maximum amount of time to wait to acquire the lock.
|
| 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.
Note: Power search temporarily enables the ALC, so ensure the appropriate included cable is connected between the NI 5654 ALC IN connector and the NI 5696 ALC OUT connector to successfully perform a power search. Related Topic: Power Search |
| 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.
|
| 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 |
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 | Obsolete.
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.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WaitUntilSettled |
Waits until the RF output signal has settled.
|
Remarks
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.