NI-DCPower .NET fx40 API Reference

Table of Contents

DCPowerDriverUtility Class

  • Updated2024-01-04
  • 4 minute(s) read
DCPowerDriverUtility Class

DCPowerDriverUtility Class

Contains methods that provide a basic set of utility operations.

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIDCPowerDCPowerSubObject
    NationalInstruments.ModularInstruments.NIDCPowerDCPowerDriverUtility

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

Syntax

public sealed class DCPowerDriverUtility : DCPowerSubObject, 
	IIviDriverUtility
Public NotInheritable Class DCPowerDriverUtility
	Inherits DCPowerSubObject
	Implements IIviDriverUtility

The DCPowerDriverUtility type exposes the following members.

Methods

  NameDescription
Public methodDisable
This method performs the same actions as Reset, except that this method also immediately sets the Enabled property to .
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExportAttributeConfigurationBuffer
Exports a session configuration to a Byte array buffer.
Public methodExportAttributeConfigurationFile
Exports a session configuration to the specified file.
Public methodGetChannelName
Returns the channel name(s) from a one-based index. Use the Count property to determine the upper bound of valid values for the index.
Public methodGetChannelNameFromString
Returns a comma-separated list of channel names from a string index list.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImportAttributeConfigurationBuffer
Imports a configuration to the session from the specified buffer.
Public methodImportAttributeConfigurationFile
Imports a configuration to the session from the specified file.
Public methodLock
Attempts to acquire a synchronization lock on this instance of the driver.
Public methodLock(PrecisionTimeSpan)
Attempts to acquire a synchronization lock on this instance of the driver and specifies the maximum amount of time to wait to acquire the lock.
Public methodReset
Resets all properties to their default value and stops export of all external signals and events.
Public methodReset(String)
Resets the specified channel(s) to a known state. This method disables power generation, resets channel properties to their default values, commits the channel properties, and leaves the channel(s) in the Uncommitted state.
Public methodResetDevice
Resets all instruments in the session to a known state.
Public methodResetWithDefaults
Resets all channels in the session to a known state. This method disables power generation, resets session properties to their default values, clears errors such as overtemperature and unexpected loss of auxiliary power, commits the session properties, and leaves the session in the Running state. In addition to exhibiting the behavior of the Reset method, this method can assign user-defined default values for configurable properties from the IVI configuration.
Public methodSelfTest
Performs the instrument self-test routine and returns the test result(s). Calling this method implicitly calls the Reset method.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top

Remarks

For more information, refer to NI DC Power Supplies and SMUs Help.

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