NI-DCPower .NET fx45 API Reference

Table of Contents

NationalInstruments.ModularInstruments.NIDCPower Namespace

  • Updated2024-01-04
  • 18 minute(s) read
NationalInstruments.ModularInstruments.NIDCPower Namespace

NationalInstruments.ModularInstruments.NIDCPower Namespace

The NI-DCPower .NET class library can be used to control NI DC Power Supplies and SMUs through the NI-DCPower instrument driver. This library includes methods and properties that exercise the functionality of the NI-DCPower instrument, including source, measure and triggering operations.

Classes

  ClassDescription
Public classDCPowerAdvanced
Provides advanced properties related to NI-DCPower.
Public classDCPowerCalibration
Provides objects of specific types to calibrate NI-DCPower.
Public classDCPowerCalibrationUtility
Represents NI-DCPower calibration utility.
Public classDCPowerCoercionEventArgs
Represents the event data obtained when a coercion event occurs.
Public classDCPowerControl
Provides methods to control the programming state of NI-DCPower.
Public classDCPowerDigitalEdgeMeasureTrigger
Provides methods and properties to configure the Digital Edge Measure trigger.
Public classDCPowerDigitalEdgeMeasureTriggerInputTerminal
Represents the input terminal for DCPowerDigitalEdgeMeasureTrigger.
Public classDCPowerDigitalEdgePulseTrigger
Represents the methods and properties used to configure digital edge for the PulseTrigger.
Public classDCPowerDigitalEdgePulseTriggerInputTerminal
Represents the input terminal for DCPowerDigitalEdgePulseTrigger.
Public classDCPowerDigitalEdgeSequenceAdvanceTrigger
Represents the methods and properties used to configure digital edge for the SequenceAdvanceTrigger.
Public classDCPowerDigitalEdgeSequenceAdvanceTriggerInputTerminal
Represents the input terminal for DCPowerDigitalEdgeSequenceAdvanceTrigger.
Public classDCPowerDigitalEdgeShutdownTriggerInputTerminal
Represents the input terminal for DCPowerOutputDigitalEdgeShutdownTrigger.
Public classDCPowerDigitalEdgeSourceTrigger
Represents the properties used to configure DCPowerDigitalEdgeSourceTrigger.
Public classDCPowerDigitalEdgeSourceTriggerInputTerminal
Represents the input terminal for DCPowerDigitalEdgeSourceTrigger.
Public classDCPowerDigitalEdgeStartTrigger
Represents the properties used to configure DCPowerDigitalEdgeStartTrigger.
Public classDCPowerDigitalEdgeStartTriggerInputTerminal
Represents the input terminal for DCPowerDigitalEdgeStartTrigger.
Public classDCPowerDriverIdentity
Provides the methods and properties that provide information about the instrument and the NI-DCPower driver.
Public classDCPowerDriverLock
Provides synchronization locks obtained on the driver session.
Public classDCPowerDriverOperation
Provides properties that affect the operation of the instrument driver.
Public classDCPowerDriverUtility
Contains methods that provide a basic set of utility operations.
Public classDCPowerEvents
Provides underlying hardware events of specific types.
Public classDCPowerExternalCalibration
Provides the properties used in external calibration of NI-DCPower.
Public classDCPowerInstrument
Provides properties and methods used to perform NI-DCPower instrument specific operations.
Public classDCPowerInstrumentAdvanced
Provides advanced properties for the instrument.
Public classDCPowerInstrumentCalibration
Provides objects of specific types to configure calibration of the instrument.
Public classDCPowerInstrumentCollection
Represents a strongly typed collection of DCPowerInstrument objects.
Public classDCPowerInstrumentIdentity
Provides the methods and properties that provide information about the instrument.
Public classDCPowerInstrumentSelfCalibration
Defines properties used to configure self calibration of the instrument.
Public classDCPowerInterchangeCheckWarningEventArgs
Provides NI-DCPower interchange check warning event arguments.
Public classDCPowerMeasureCompleteEvent
Represents the properties used to configure the underlying hardware MeasureCompleteEvent.
Public classDCPowerMeasureCompleteEventOutputTerminal
Represents the output terminal for DCPowerMeasureCompleteEvent.
Public classDCPowerMeasureCompleteEventPulse
Represents the properties used to configure the pulse of DCPowerMeasureCompleteEvent.
Public classDCPowerMeasureCompleteEventToggle
Represents the properties used to configure the toggle for measure complete event.
Public classDCPowerMeasurement
Represents properties related to all measurement channels in session.
Public classDCPowerMeasurementConfiguration
Represents properties that apply to all measurement channels that are in Session.
Public classDCPowerMeasurementEventArgsT
Holds the event data obtained after asynchronous measurement completion.
Public classDCPowerMeasureTrigger
Represents the properties used to configure the Measure trigger for NI-DCPower.
Public classDCPowerMeasureTriggerExportedOutputTerminal
Represents the output terminal for exporting the DCPowerMeasureTrigger.
Public classDCPowerOutput
Provides properties and methods used to perform NI-DCPower channel specific operations.
Public classDCPowerOutputCollection
Represents a strongly typed collection of DCPowerOutput objects.
Public classDCPowerOutputControl
Provides methods to control the programming state of NI-DCPower.
Public classDCPowerOutputDeviceSpecific
Provides device-specific properties related to NI-DCPower.
Public classDCPowerOutputDeviceSpecificLCR
Provides LCR meter specific properties related to NI-DCPower.
Public classDCPowerOutputDigitalEdgeMeasureTrigger
Represents the methods and properties used to configure the digital edge for the MeasureTrigger for the specified channel(s).
Public classDCPowerOutputDigitalEdgePulseTrigger
Represents the methods and properties used to configure the digital edge for the PulseTrigger for the specified channel(s).
Public classDCPowerOutputDigitalEdgeSequenceAdvanceTrigger
Represents the methods and properties used to configure the digital edge for the SequenceAdvanceTrigger for the specified channel(s).
Public classDCPowerOutputDigitalEdgeShutdownTrigger
Represents the methods and properties used to configure digital edge for the ShutdownTrigger.
Public classDCPowerOutputDigitalEdgeSourceTrigger
Represents the methods and properties used to configure the digital edge for the SourceTrigger for the specified channel(s).
Public classDCPowerOutputDigitalEdgeStartTrigger
Represents the methods and properties used to configure the digital edge for the StartTrigger for the specified channel(s).
Public classDCPowerOutputEvents
Provides underlying hardware events of specific types.
Public classDCPowerOutputLCR
Contains properties related to NI-DCPower channel specific operations.
Public classDCPowerOutputLCRAdvanced
Properties for controlling advanced features of LCR Output
Public classDCPowerOutputLCRCompensation
Contains properties related to NI-DCPower LCR compensation-specific operations.
Public classDCPowerOutputMeasureCompleteEvent
Represents the properties used to configure the underlying hardware MeasureCompleteEvent.
Public classDCPowerOutputMeasureCompleteEventPulse
Represents the properties used to configure the pulse of DCPowerOutputMeasureCompleteEvent.
Public classDCPowerOutputMeasureCompleteEventToggle
Represents the properties used to configure the toggle for output measure complete event.
Public classDCPowerOutputMeasurement
Provides properties and methods used to perform operations related to NI-DCPower output measurements.
Public classDCPowerOutputMeasureTrigger
Represents the methods and properties used to configure the MeasureTrigger for NI-DCPower.
Public classDCPowerOutputPulseCompleteEvent
Represents the properties used to configure the underlying hardware PulseCompleteEvent.
Public classDCPowerOutputPulseCompleteEventPulse
Contains properties used to configure the pulse characteristics of the Pulse Complete event.
Public classDCPowerOutputPulseTrigger
Represents the methods and properties used to configure the PulseTrigger for NI-DCPower.
Public classDCPowerOutputReadyForPulseTriggerEvent
Contains properties used to configure the Ready For Pulse Trigger event.
Public classDCPowerOutputReadyForPulseTriggerEventPulse
Represents the properties used to configure the pulse of ReadyForPulseTriggerEvent.
Public classDCPowerOutputSequenceAdvanceTrigger
Represents the methods and properties used to configure the SequenceAdvanceTrigger for NI-DCPower.
Public classDCPowerOutputSequenceEngineDoneEvent
Represents the properties used to configure the underlying hardware SequenceEngineDoneEvent.
Public classDCPowerOutputSequenceEngineDoneEventPulse
Represents the properties used to configure the pulse of DCPowerOutputSequenceEngineDoneEvent.
Public classDCPowerOutputSequenceEngineDoneEventToggle
Represents the properties used to configure the toggle for output sequence engine done event.
Public classDCPowerOutputSequenceIterationCompleteEvent
Represents the properties used to configure the underlying hardware DCPowerOutputSequenceIterationCompleteEvent event.
Public classDCPowerOutputSequenceIterationCompleteEventPulse
Represents the properties used to configure the pulse of SequenceIterationCompleteEvent.
Public classDCPowerOutputSequenceIterationCompleteEventToggle
Represents the properties used to configure the toggle for output sequence iteration complete event.
Public classDCPowerOutputShutdownTrigger
Represents the methods and properties used to configure the ShutdownTrigger for NI-DCPower.
Public classDCPowerOutputSource
Represents the source unit channel.
Public classDCPowerOutputSourceAdvanced
Properties for controlling the advanced features of the source unit.
Public classDCPowerOutputSourceAdvancedSequencing
Provides methods and properties for configuring the source and measure unit with a series of property values.
Public classDCPowerOutputSourceCompleteEvent
Represents the properties used to configure the underlying hardware SourceCompleteEvent.
Public classDCPowerOutputSourceCompleteEventPulse
Represents the properties used to configure the pulse of SourceCompleteEvent.
Public classDCPowerOutputSourceCompleteEventToggle
Represents the properties used to configure the toggle for output source complete event.
Public classDCPowerOutputSourceCurrent
Contains properties used to configure the current of source unit channel.
Public classDCPowerOutputSourceCustomTransientResponse
Contains properties used to configure the custom transient response of source unit channel.
Public classDCPowerOutputSourceCustomTransientResponseCurrent
Contains properties used to configure the custom transient response current of source unit channel.
Public classDCPowerOutputSourceCustomTransientResponseVoltage
Contains properties used to configure the custom transient response voltage of source unit channel.
Public classDCPowerOutputSourceOutput
Contains properties related to NI-DCPower channel specific operations.
Public classDCPowerOutputSourceOutputCutoff
Properties for controlling output cutoff limits for supported instruments.
Public classDCPowerOutputSourcePulseCurrent
Contains properties that change channel settings when the channel is configured for PulseCurrent.
Public classDCPowerOutputSourcePulseVoltage
Contains properties used to configure the pulse voltage of source unit channel.
Public classDCPowerOutputSourceTrigger
Represents the methods and properties used to configure the SourceTrigger for NI-DCPower.
Public classDCPowerOutputSourceVoltage
Contains properties used to configure the voltage of source unit channel.
Public classDCPowerOutputStartTrigger
Represents the methods and properties used to configure the StartTrigger for NI-DCPower.
Public classDCPowerOutputTriggers
Provides underlying triggers of specific types.
Public classDCPowerPulseCompleteEvent
Represents the properties used to configure the underlying hardware PulseCompleteEvent.
Public classDCPowerPulseCompleteEventOutputTerminal
Represents the output terminal for DCPowerPulseCompleteEvent.
Public classDCPowerPulseCompleteEventPulse
Contains properties used to configure the pulse characteristics of the Pulse Complete event.
Public classDCPowerPulseTrigger
Defines methods and properties used to configure the Pulse trigger.
Public classDCPowerPulseTriggerExportedOutputTerminal
Represents the output terminal for DCPowerSequenceAdvanceTrigger.
Public classDCPowerReadyForPulseTriggerEvent
Contains properties used to configure the Ready For Pulse Trigger event.
Public classDCPowerReadyForPulseTriggerEventOutputTerminal
Represents the output terminal for DCPowerReadyForPulseTriggerEvent.
Public classDCPowerReadyForPulseTriggerEventPulse
Represents the properties used to configure the pulse of ReadyForPulseTriggerEvent.
Public classDCPowerSelfCalibration
Defines methods and properties used to perform self calibration and query data related to self calibration.
Public classDCPowerSequenceAdvanceTrigger
Represents the properties used to configure the SequenceAdvanceTrigger trigger for NI-DCPower.
Public classDCPowerSequenceAdvanceTriggerExportedOutputTerminal
Represents the output terminal for DCPowerSequenceAdvanceTrigger.
Public classDCPowerSequenceEngineDoneEvent
Represents the properties used to configure the underlying hardware SequenceEngineDoneEvent.
Public classDCPowerSequenceEngineDoneEventOutputTerminal
Represents the destination terminal for DCPowerSequenceEngineDoneEvent.
Public classDCPowerSequenceEngineDoneEventPulse
Represents the properties used to configure the pulse of DCPowerSequenceEngineDoneEvent.
Public classDCPowerSequenceEngineDoneEventToggle
Represents the properties used to configure the toggle for sequence engine done event.
Public classDCPowerSequenceIterationCompleteEvent
Represents the properties used to configure the underlying hardware DCPowerSequenceIterationCompleteEvent event.
Public classDCPowerSequenceIterationCompleteEventOutputTerminal
Represents the destination terminal for DCPowerSequenceIterationCompleteEvent.
Public classDCPowerSequenceIterationCompleteEventPulse
Represents the properties used to configure the pulse of SequenceIterationCompleteEvent.
Public classDCPowerSequenceIterationCompleteEventToggle
Represents the properties used to configure the toggle for sequence iteration complete event.
Public classDCPowerSource
Contains properties used to configure NI-DCPower for signal generation.
Public classDCPowerSourceCompleteEvent
Represents the properties used to configure the underlying hardware SourceCompleteEvent.
Public classDCPowerSourceCompleteEventOutputTerminal
Represents the destination terminal for DCPowerSourceCompleteEvent.
Public classDCPowerSourceCompleteEventPulse
Represents the properties used to configure the pulse of SourceCompleteEvent.
Public classDCPowerSourceCompleteEventToggle
Represents the properties used to configure the toggle for source complete event.
Public classDCPowerSourceTrigger
Represents the properties used to configure the SourceTrigger for NI-DCPower.
Public classDCPowerSourceTriggerExportedOutputTerminal
Represents the output terminal for DCPowerSourceTrigger.
Public classDCPowerStartTrigger
Represents the properties used to configure the StartTrigger for NI-DCPower.
Public classDCPowerStartTriggerExportedOutputTerminal
Represents the output terminal for DCPowerStartTrigger.
Public classDCPowerSubObject
Represents members that are common to all sub-object NI-DCPower classes. This is an internal class and is not intended for external use.
Public classDCPowerTriggers
Provides underlying triggers of specific types.
Public classDCPowerWarning
Provides warning codes for the warnings raised by the underlying driver.
Public classDCPowerWarningEventArgs
Represents the properties under the Warning Event Args raised during a driver warning.
Public classNIDCPower
Defines a root class that is used to identify and control the instrument session.

Structures

  StructureDescription
Public structureDCPowerFetchResult
Represents the result of Fetch(String, PrecisionTimeSpan, Int32) method.
Public structureDCPowerLCRLoadCompensationSpot
Specifies a load measurement for performing compensation.
Public structureDCPowerMeasureResult
Represents the result of Measure(String) method.
Public structureDCPowerSelfTestResult
Represents the result of the SelfTest method.
Public structureNILCRMeasurement
Specifies a LCR measurement.

Enumerations

  EnumerationDescription
Public enumerationDCPowerAdvancedSequenceProperty
Specifies the properties that you can reconfigure per step in the advanced sequence.
Public enumerationDCPowerCableLength
Specifies values for the CableLength property.
Public enumerationDCPowerComplianceLimitSymmetry
Specifies whether compliance limits for current generation and voltage generation for the device are applied symmetrically about 0 V and 0 A or asymmetrically with respect to 0 V and 0 A.
Public enumerationDCPowerConductionVoltageMode
Specifies values for the ConductionVoltageMode property.
Public enumerationDCPowerEventOutputBehavior
Specifies values for the event output behavior property.
Public enumerationDCPowerEventToggleInitialState
Specifies values for the event toggle initial state property.
Public enumerationDCPowerInstrumentMode
Specifies values for the InstrumentMode property.
Public enumerationDCPowerIsolationState
Specifies values for the IsolationState property.
Public enumerationDCPowerLCRAutomaticLevelControl
Specifies values for the AutomaticLevelControl and DCBiasAutomaticLevelControl properties.
Public enumerationDCPowerLCRCompensationType
Specifies the type of compensation for LCR measurements.
Public enumerationDCPowerLCRDCBiasSource
Specifies values for the DCBiasSource property.
Public enumerationDCPowerLCRDCBiasTransientResponse
Specifies values for the DCBiasTransientResponse property.
Public enumerationDCPowerLCRImpedanceAutorange
Specifies values for the ImpedanceAutoRange property.
Public enumerationDCPowerLCRImpedanceRangeSource
Specifies the values for the ImpedanceRangeSource property.
Public enumerationDCPowerLCRMeasurementTime
Specifies values for the MeasurementTime property.
Public enumerationDCPowerLCROpenShortLoadCompensationDataSource
Specifies values for the OpenShortLoadCompensationDataSource property.
Public enumerationDCPowerLCRReferenceValueType
Specifies values for the DCPowerLCRLoadCompensationSpot property.
Public enumerationDCPowerLCRSourceDelayMode
Specifies values for the SourceDelayMode property.
Public enumerationDCPowerLCRStimulusFunction
Specifies values for the StimulusFunction property.
Public enumerationDCPowerMeasureApertureTimeUnits
Specifies values for ApertureTimeUnits property.
Public enumerationDCPowerMeasurementAutorange
Specifies values for the Autorange property.
Public enumerationDCPowerMeasurementAutorangeApertureTimeMode
Specifies values for the AutorangeApertureTimeMode property.
Public enumerationDCPowerMeasurementAutorangeBehavior
Specifies values for the AutorangeBehavior property.
Public enumerationDCPowerMeasurementAutorangeThresholdMode
Specifies values for the AutorangeThresholdMode property.
Public enumerationDCPowerMeasurementAutoZero
Specifies values for AutoZero property.
Public enumerationDCPowerMeasurementNoiseRejection
Specifies the type of NoiseRejection.
Public enumerationDCPowerMeasurementOutputState
Public enumerationDCPowerMeasurementSense
Specifies values for the Sense property.
Public enumerationDCPowerMeasurementWhen
Specifies the values for the MeasureWhen property.
Public enumerationDCPowerMeasureTriggerType
Specifies the values of Type for data operations.
Public enumerationDCPowerOutputCutoffReason
The output cutoff conditions to query or clear.
Public enumerationDCPowerPowerAllocationMode
Determines whether the device sources the power its output configuration requires or a specific wattage you request; determines whether NI-DCPower proactively checks that this sourcing power is within the maximum per-channel and overall sourcing power of the device.
Public enumerationDCPowerPowerSource
Specifies values for the PowerSource property.
Public enumerationDCPowerPowerSourceInUse
Specifies the type of PowerSourceInUse.
Public enumerationDCPowerPulsePolarity
Specifies values for NI-DCPower pulse polarity.
Public enumerationDCPowerPulseTriggerType
Specifies values for the Type property.
Public enumerationDCPowerSelfCalibrationPersistence
Specifies values for SelfCalibrationPersistence property.
Public enumerationDCPowerSequenceAdvanceTriggerType
Specifies values for the Type property.
Public enumerationDCPowerShutdownTriggerType
Specifies values for the Type property.
Public enumerationDCPowerSignalSource
The trigger or event signal to route.
Public enumerationDCPowerSourceCurrentLevelAutorange
Specifies values for the CurrentLevelAutorange property.
Public enumerationDCPowerSourceCurrentLimitAutorange
Specifies values for the CurrentLimitAutorange property.
Public enumerationDCPowerSourceMode
Specifies values for the Mode property.
Public enumerationDCPowerSourceOutputCapacitance
Specifies values for the OutputCapacitance property.
Public enumerationDCPowerSourceOutputFunction
Specifies values for the Function property.
Public enumerationDCPowerSourceTransientResponse
Specifies values for the TransientResponse property.
Public enumerationDCPowerSourceTriggerType
Specifies values for the Type property.
Public enumerationDCPowerSourceVoltageLevelAutorange
Specifies values for the VoltageLevelAutorange property.
Public enumerationDCPowerSourceVoltageLimitAutorange
Specifies values for the VoltageLimitAutorange property.
Public enumerationDCPowerStartTriggerType
Specifies values for the Type property.
Public enumerationDCPowerTriggerEdge
Specifies the transitions of the signal from one discrete level to another.

Log in to get a better experience