NI-DCPower .NET fx45 API Reference

Table of Contents

DCPowerOutputSourceAdvancedSequencing Methods

  • Updated2024-01-04
  • 5 minute(s) read
DCPowerOutputSourceAdvancedSequencing Methods

DCPowerOutputSourceAdvancedSequencing Methods

The DCPowerOutputSourceAdvancedSequencing type exposes the following members.

Methods

  NameDescription
Public methodCreateAdvancedSequence
Creates an empty advanced sequence. Call the CreateAdvancedSequenceStep(Boolean) method to add steps to the active advanced sequence, or the CreateAdvancedSequenceCommitStep(Boolean) method to add a Commit step.

Remarks

You can create mnultiple advanced sequences for a channel. Advanced sequences for a particular channel are independent from any advanced sequences of other channels. You can configure advanced sequences for one channel at a time or you can configure identical advanced sequences for multiple channels in unison.

Note Note
Each channel can have only one active advanced sequence at a time.

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

Note Note
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.

Use this method in the Uncommitted or Committed programming states. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for more information about NI-DCPower programming states.

Public methodCreateAdvancedSequenceCommitStep
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.
Public methodCreateAdvancedSequenceStep
Creates a new advanced sequence step in the active advanced sequence, specified by the ActiveAdvancedSequence property. You can configure properties for the new step only after the step is created.

Remarks

When you create an advanced sequence step, each property you passed to CreateAdvancedSequence(String, DCPowerAdvancedSequenceProperty, Boolean) is reset to its default value for the new step. To configure the step, you must first designate the new step as the active step using the ActiveAdvancedSequenceStep property or the setAsActiveStep parameter of this method. 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. 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.
Public methodDeleteAdvancedSequence
Deletes a previously created advanced sequence and all the advanced sequence steps in the advanced sequence.

Remarks

You must set the Mode to Sequence to use this method. Refer to DCPowerAdvancedSequenceProperty for more information about supported properties. 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.
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 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

See Also

Log in to get a better experience