RfpmUtilityForSwitchReceiver.SetPath Method (String, ReceiverPath, ReceiverCouplingPath, TimeSpan)
- Updated2023-12-28
- 2 minute(s) read
RfpmUtilityForSwitchReceiverSetPath Method (String, ReceiverPath, ReceiverCouplingPath, TimeSpan)
Creates a path between specified port and the receiver (RX) using the specified receiverPath and receiverCouplingPath.
This method does not support the mmWave subsystem.
This method does not support the mmWave subsystem.
Namespace: NationalInstruments.ModularInstruments.NIRfpm
Assembly: NationalInstruments.ModularInstruments.NIRfpm.Fx40 (in NationalInstruments.ModularInstruments.NIRfpm.Fx40.dll) Version: 2023
Syntax
public void SetPath( string port, ReceiverPath receiverPath, ReceiverCouplingPath receiverCouplingPath, TimeSpan maxTime )
Public Sub SetPath ( port As String, receiverPath As ReceiverPath, receiverCouplingPath As ReceiverCouplingPath, maxTime As TimeSpan )
Parameters
- port
- Type: SystemString
The port to use to create the path. - receiverPath
- Type: NationalInstruments.ModularInstruments.NIRfpmReceiverPath
The receiver (RX) path to use to create the path. - receiverCouplingPath
- Type: NationalInstruments.ModularInstruments.NIRfpmReceiverCouplingPath
The receiver (RX) coupling path to use to create the path. - maxTime
- Type: SystemTimeSpan
The time to wait for path creation to complete before throwing an exception.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | SetPath(String, ReceiverPath, ReceiverCouplingPath, TimeSpan) was called after the associated NIRfpm or RfpmDriverUtility object was disposed. |
| SelectorNameException |
The value for port is Empty.
- or - The value for port is invalid.- or - The value for port is unknown. |
| ArgumentNullException | The value for port is . |
| ArgumentException |
The value for receiverPath is invalid.
- or - The value for receiverCouplingPath is invalid.- or - The value for maxTime is negative. |
| IviCDriverException |
The path could not be created within the specified maxTime period.
- or - The underlying NI-RFPM driver returned an error. |
Remarks
If a previously created path conflicts with the specified path, the previous path is disconnected
before creating path using the specified receiver (RX).