RfsgDriverUtility.WaitUntilSettled Method
- Updated2024-05-08
- 1 minute(s) read
RfsgDriverUtilityWaitUntilSettled Method
Waits until the RF output signal has settled.
Namespace: NationalInstruments.ModularInstruments.NIRfsg
Assembly: NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022
Syntax
public void WaitUntilSettled( int maxTimeMilliseconds )
Public Sub WaitUntilSettled ( maxTimeMilliseconds As Integer )
Parameters
- maxTimeMilliseconds
- Type: SystemInt32
Defines the maximum time the method waits for the output to be settled. If the maximum time is exceeded, this method returns the an error. If you set this parameter to -1, NI-RFSG waits indefinitely until it is settled. The units are expressed in milliseconds.The default value is 10000.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The WaitUntilSettled(Int32) method was accessed after the associated NIRfsg object was disposed. |
Remarks
This method is useful for devices that support on-the-fly configuration changes (changes while in the Generation state). Call this method after you make a dynamic change to wait for the output to settle.
You can also call this method after calling Commit to wait for changes to settle. Do not call this method after you call Initiate because Initiate does not return until the output is settled.