NI-RFPM API Reference

Table of Contents

NIRfpmSwitch Class

  • Updated2023-12-28
  • 4 minute(s) read
NIRfpmSwitch Class

NIRfpmSwitch Class

Defines a root class that is used to identify and control the instrument session.

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIRfpmSwitchNIRfpmSwitch

Namespace:  NationalInstruments.ModularInstruments.NIRfpmSwitch
Assembly:  NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40 (in NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40.dll) Version: 2023

Syntax

public sealed class NIRfpmSwitch : IIviDriver, 
	IServiceProvider, IDisposable
Public NotInheritable Class NIRfpmSwitch
	Implements IIviDriver, IServiceProvider, IDisposable

The NIRfpmSwitch type exposes the following members.

Constructors

  NameDescription
Public methodNIRfpmSwitch(IntPtr)
Initializes a new instance of the NIRfpmSwitch class from an existing instrument handle.
Public methodNIRfpmSwitch(String, Boolean, Boolean)
Initializes a new instance of the NIRfpmSwitch class.
Public methodNIRfpmSwitch(String, Boolean, Boolean, String)
Initializes a new instance of the NIRfpmSwitch class and sets the initial state of session properties.
Public methodNIRfpmSwitch(String, Boolean, Boolean, LockType, String)
Initializes a new instance of the NIRfpmSwitch class.
Public methodNIRfpmSwitch(String, Boolean, Boolean, LockType, String, String)
Initializes a new instance of the NIRfpmSwitch class.
Top

Properties

  NameDescription
Public propertyChannels
Gets a RfpmSwitchChannelCollection object which represents the channel collection and its properties.
Public propertyDriverOperation
Gets a RfpmSwitchDriverOperation object that defines methods and properties for common operations on the NI-RFPM Switch driver.
Public propertyIdentity
Gets a RfpmSwitchDriverIdentity object which defines the methods and properties for identifying the NI-RFPM Switch driver.
Public propertyIsDisposed
Gets a value indicating whether the session has been disposed.
Public propertyPath
Gets a RfpmSwitchPath object which is used to build a channel path in the NI-RFPM Switch driver.
Public propertyUtility
Gets a RfpmSwitchDriverUtility object to access the utility features on the NI-RFPM Switch driver.
Top

Methods

  NameDescription
Public methodClose
Closes the session to the device.
Public methodDispose
Closes the specified session and deallocates the reserved resources, if not already disposed.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInstrumentHandle
Returns the pointer to the underlying instrument handle.
Public methodGetService
Returns a service object on the basis of the type mentioned in the serviceType parameter.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top

Remarks

All properties, methods, and events fall under either NIRfpmSwitch or are the sub-objects of this class. To interact with the NationalInstruments.ModularInstruments.NIRfpmSwitch .NET class library, you must create an instance of this class.

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.

See Also

Log in to get a better experience