NI-DCPower .NET fx45 API Reference

Table of Contents

DCPowerOutputSourceAdvancedSequencing.CreateAdvancedSequenceCommitStep Method

  • Updated2024-01-04
  • 3 minute(s) read
DCPowerOutputSourceAdvancedSequencing.CreateAdvancedSequenceCommitStep Method

DCPowerOutputSourceAdvancedSequencingCreateAdvancedSequenceCommitStep Method

Creates a Commit step in the active advanced sequence. A Commit step configures the channels to a user-defined known state before starting the advanced sequence.

Remarks

When you create an advanced sequence step or Commit step, each property you passed to CreateAdvancedSequence(String, DCPowerAdvancedSequenceProperty, Boolean) is reset to its default value for the new step. To configure the Commit step, you must first designate the Commit step as the active step by setting the ActiveAdvancedSequenceStep property to -1 or the setAsActiveStep parameter of this method to . Once the step is active, you can configure the properties for the step.

You must set the Mode to Sequence to use this method. Refer to DCPowerAdvancedSequenceProperty for more information about supported properties.

Note Note
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.

This method is not supported by all instruments. Refer to the Supported Functions by Device topic in the NI DC Power Supplies and SMUs Help for information about supported instruments.

Using the SetSequence(Double) method with Advanced Sequence methods for the same channel in the same session is unsupported.

When a Commit step exists in the active advanced sequence, you cannot set Function to PulseVoltage or PulseCurrent in either the Commit step (-1) or step 0.

When Does the Commit Step Run in a Sequence?

The driver applies the Commit step to the device when the session transitions to the Committed state. After the driver applies the Commit step to the device, the driver waits until the Source Delay has elpased before waiting for the Start trigger.

Note Note

Differences Between the Commit Step and Other Steps

  • The source unit does not wait on any triggers before running the Commit step.
  • The source unit does not emit a Source Complete Event when the Commit step is complete.
  • No measurements are taken in the Commit step, therefore you cannot set the ApertureTime, RecordLength, or NoiseRejection properties in the Commit step.
  • The SequenceStepDeltaTime property does not apply to the Commit step, and you cannot configure the SequenceStepDeltaTime property in the Commit step.

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

Syntax

public void CreateAdvancedSequenceCommitStep(
	bool setAsActiveStep
)
Public Sub CreateAdvancedSequenceCommitStep ( 
	setAsActiveStep As Boolean
)

Parameters

setAsActiveStep
Type: SystemBoolean
Specifies that this current step in the active sequence is active.

Exceptions

ExceptionCondition
ObjectDisposedException The method was called after the associated NIDCPower object was disposed.
OperationNotSupportedException The method was called in a session to unsupported hardware.
SelectorNameException The method was called with an unknown channel.
IviCDriverException The underlying NI-DCPower driver returned an error.

See Also

Log in to get a better experience