NI-RFPM API Reference

RfpmUtilityForSwitchReceiver.SetPath Method (RfpmSwitchPathDescription, TimeSpan)

  • Updated2023-12-28
  • 1 minute(s) read
RfpmUtilityForSwitchReceiver.SetPath Method (RfpmSwitchPathDescription, TimeSpan)

RfpmUtilityForSwitchReceiverSetPath Method (RfpmSwitchPathDescription, TimeSpan)

Creates a path between the channels specified with pathDescription.
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(
	RfpmSwitchPathDescription pathDescription,
	TimeSpan maxTime
)
Public Sub SetPath ( 
	pathDescription As RfpmSwitchPathDescription,
	maxTime As TimeSpan
)

Parameters

pathDescription
Type: NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchPathDescription
The switch path to use to create a path. One of the channels in the switch path must be a receiver (RX).
maxTime
Type: SystemTimeSpan
The time to wait for path creation to complete before throwing an exception.

Exceptions

ExceptionCondition
ObjectDisposedExceptionSetPath(RfpmSwitchPathDescription, TimeSpan) was called after the associated NIRfpm or RfpmDriverUtility object was disposed.
ArgumentNullException The value for pathDescription is .
ArgumentException The value for maxTime is negative.
SelectorNameExceptionpathDescription contains unknown channels.

- or -

pathDescription contains invalid channels.
IviCDriverException The path could not be created within the specified maxTime period.

- or -

The underlying NI-RFPM driver returned an error.

Remarks

If pathDescription specifies a source (TX), no path is created. If a previously created path conflicts with the specified path, the previous path is disconnected before creating path using the specified receiver (RX).

See Also

Log in to get a better experience