RfpmDriverUtility.ResetWithOptions Method
- Updated2023-12-28
- 2 minute(s) read
RfpmDriverUtilityResetWithOptions Method
Performs a selective reset of underlying driver sessions.
Namespace: NationalInstruments.ModularInstruments.NIRfpm
Assembly: NationalInstruments.ModularInstruments.NIRfpm.Fx40 (in NationalInstruments.ModularInstruments.NIRfpm.Fx40.dll) Version: 2023
Syntax
public void ResetWithOptions( string optionString )
Public Sub ResetWithOptions ( optionString As String )
Parameters
- optionString
- Type: SystemString
A string that specifies the selective components to reset or preserve. Refer to the table in the remarks for a list of valid options.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | ResetWithOptions(String) was called after the associated NIRfpm or RfpmDriverUtility object was disposed. |
| IviCDriverException | The underlying NI-RFPM driver returned an error. |
Remarks
Use optionString to specify multiple driver options as a comma-separated list.
These options allow for optimizations such as preserving calibration data in the driver and preserving waveforms and scripts in the RFSG driver.
 Note |
|---|
| An NI-RFPM session works with valid NI-RFSA, NI-RFSG, and NI-RFPM Switch sessions. |
Valid options include:
| Option String | Description |
|---|---|
| RFSARFSGPreserveDeembeddingTables | Preserves previously configured de-embedding tables in the NI-RFSA and NI-RFSG sessions. This option is only supported on the mmWave subsystem. |
| RFPMPreserveReferenceLevelPortExtensionTables | Resets the RFPM driver without clearing the reference level port extension tables you have configured. This option is only supported on the mmWave subsystem. |
| RFSGPreserveWaveforms | Resets the RFSG driver session without deleting waveforms stored to the device's memory. Must be used together with RFSGPreserveScripts. |
| RFSGPreserveScripts | Resets the RFSG driver session without deleting scripts stored to the device's memory. Must be used together with RFSGPreserveWaveforms. |
| RFPMPreserveSweepSettings | Resets the RFPM driver without clearing sweep settings that have been loaded into memory. |
| RFPMPreserveCalibrationData | Resets the RFPM driver without clearing calibration data that has been loaded into memory or collected by the driver. |
| RFPMPreserveDeembedding | Resets the RFPM driver without clearing de-embedding data that has been loaded into memory. |
| RFSARFSGPreserveRoutes | Preserves previously configured routes in the NI-RFSA and NI-RFSG sessions. This option is not supported on a STS RF Subsystem using PXIe-5644/5645/5646 VST. |