Method ForceCurrent

Namespace

NationalInstruments.SemiconductorTestLibrary.InstrumentAbstraction.DCPower

Assembly

NationalInstruments.SemiconductorTestLibrary.Extensions.dll

ForceCurrent(DCPowerSessionsBundle, double, double?, double?, double?, bool)

Forces current on the target pins at the specified level. Must at least provide a level value, and the method will assume all other properties that have been previously set. Optionally, can also provide a specific voltage limit, current level range, voltage limit range values directly.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, double currentLevel, double? voltageLimit = null, double? currentLevelRange = null, double? voltageLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

currentLevel double

The current level to force.

voltageLimit double?

The voltage limit to use.

currentLevelRange double?

The current level range to use.

voltageLimitRange double?

The voltage limit range to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, IDictionary<string, double>, double?, double?, double?, bool)

Forces current on the target pins at the specified pin-unique level. Must at least provide a level value, and the method will assume all other properties that have been previously set. Optionally, can also provide a specific voltage limit, current level range, voltage limit range values directly.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, IDictionary<string, double> currentLevels, double? voltageLimit = null, double? currentLevelRange = null, double? voltageLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

currentLevels IDictionary<string, double>

The current level to force for different pins.

voltageLimit double?

The voltage limit to use.

currentLevelRange double?

The current level range to use.

voltageLimitRange double?

The voltage limit range to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, SiteData<double>, double?, double?, double?, bool)

Forces current on the target pins at the specified site-unique level. Must at least provide a level value, and the method will assume all other properties that have been previously set. Optionally, can also provide a specific voltage limit, current level range, voltage limit range values directly.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, SiteData<double> currentLevels, double? voltageLimit = null, double? currentLevelRange = null, double? voltageLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

currentLevels SiteData<double>

The current level to force for different sites.

voltageLimit double?

The voltage limit to use.

currentLevelRange double?

The current level range to use.

voltageLimitRange double?

The voltage limit range to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, PinSiteData<double>, double?, double?, double?, bool)

Forces current on the target pins at the specified pin- and site-unique level. Must at least provide a level value, and the method will assume all other properties that have been previously set. Optionally, can also provide a specific voltage limit, current level range, voltage limit range values directly.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, PinSiteData<double> currentLevels, double? voltageLimit = null, double? currentLevelRange = null, double? voltageLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

currentLevels PinSiteData<double>

The current level to force for different site-pin pairs.

voltageLimit double?

The voltage limit to use.

currentLevelRange double?

The current level range to use.

voltageLimitRange double?

The voltage limit range to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, DCPowerSourceSettings, bool)

Forces current using specified source settings.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, DCPowerSourceSettings settings, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

settings DCPowerSourceSettings

The settings to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, SiteData<DCPowerSourceSettings>, bool)

Forces current using specified site-unique source settings.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, SiteData<DCPowerSourceSettings> settings, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

settings SiteData<DCPowerSourceSettings>

The per-site settings to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, IDictionary<string, DCPowerSourceSettings>, bool)

Forces current using specified pin-unique source settings.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, IDictionary<string, DCPowerSourceSettings> settings, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

settings IDictionary<string, DCPowerSourceSettings>

The per-pin settings to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.

ForceCurrent(DCPowerSessionsBundle, PinSiteData<DCPowerSourceSettings>, bool)

Forces current using specified pin- and site-unique source settings.

public static void ForceCurrent(this DCPowerSessionsBundle sessionsBundle, PinSiteData<DCPowerSourceSettings> settings, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

settings PinSiteData<DCPowerSourceSettings>

The per-site-pin-pair settings to use.

waitForSourceCompletion bool

Setting this to True will wait until sourcing is complete before continuing, which includes the set amount of source delay. Otherwise, the source delay amount is not directly accounted for by this method and the WaitForEvent must be manually invoked in proceeding code.