RfpmSwitchDriverUtility Class
- Updated2023-12-28
- 3 minute(s) read
RfpmSwitchDriverUtility Class
Defines the methods that provide a basic set of utility operations.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchSubObject
NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchDriverUtility
NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchSubObject
NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchDriverUtility
Namespace: NationalInstruments.ModularInstruments.NIRfpmSwitch
Assembly: NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40 (in NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40.dll) Version: 2023
Syntax
public sealed class RfpmSwitchDriverUtility : RfpmSwitchSubObject, IIviDriverUtility, IDisposable
Public NotInheritable Class RfpmSwitchDriverUtility Inherits RfpmSwitchSubObject Implements IIviDriverUtility, IDisposable
The RfpmSwitchDriverUtility type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | DeviceTemperature |
Gets the temperature, in degrees Celsius, for the switch device.
|
| ExternalPortCount |
Gets an Int32 representing the number of external ports for the switch device.
|
Methods
| Name | Description | |
|---|---|---|
 | Disable |
Places the instrument in an inactive state as quickly as possible.
|
| Dispose |
Disposes the RfpmSwitchDriverUtility object.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ErrorQuery |
Reads an error code and a message from the instrument error queue.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Lock |
Acquires a synchronization lock on this instance of the NI-RFPM Switch driver.
|
| Lock(PrecisionTimeSpan) |
Acquires a synchronization lock on this instance of the NI-RFPM Switch driver.
|
| Reset |
Disconnects all created paths and returns the switch device to the initialization state.
|
| ResetDevice |
Resets all attributes to their default states, and clears a latched interlock signal.
|
| ResetWithDefaults |
Resets the switch device and applies initial settings from the logical name which you used to initialize the session.
|
| SelfTest |
Verifies that the switch device can communicate with the switch.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
This class cannot be instantiated directly. It is instantiated when the NIRfpmSwitch session object is created. Access this class using Utility.
For more information, refer to the NI-SWITCH Function Reference.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.