DCPowerControl Class
- Updated2024-01-04
- 3 minute(s) read
DCPowerControl Class
Provides methods to control the programming state of NI-DCPower.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIDCPowerDCPowerSubObject
NationalInstruments.ModularInstruments.NIDCPowerDCPowerControl
NationalInstruments.ModularInstruments.NIDCPowerDCPowerSubObject
NationalInstruments.ModularInstruments.NIDCPowerDCPowerControl
Namespace: NationalInstruments.ModularInstruments.NIDCPower
Assembly: NationalInstruments.ModularInstruments.NIDCPower.Fx45 (in NationalInstruments.ModularInstruments.NIDCPower.Fx45.dll) Version: 2023
Syntax
public sealed class DCPowerControl : DCPowerSubObject
Public NotInheritable Class DCPowerControl Inherits DCPowerSubObject
The DCPowerControl type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Abort |
Transitions the NI-DCPower session from the Running state to the Uncommitted state. If a sequence is running,
then the NI-DCPower session is stopped. Any configuration methods called after this method are not applied until the Initiate
method is called. If power output is enabled when you call the Abort method,
the output channels remain in their current state and continue providing power.
Use the Enabled property to disable power output on a per channel basis. Use the
Reset method to disable output on all channels.
|
| Commit |
Applies the settings that you configured previously to the device. Calling this method moves the NI-DCPower session
from the Uncommitted state into the Committed state. If you modify any property after you call this method,
the NI-DCPower session reverts to the Uncommitted state. Use the Initiate method to transition
to the Running state.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initiate |
Starts generation or acquisition, causing the NI-DCPower session to leave the Uncommitted state or
Committed state and enter the Running state. To return to the Uncommitted state call the Abort method.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.