Method ForceVoltage

Namespace

NationalInstruments.SemiconductorTestLibrary.InstrumentAbstraction.DCPower

Assembly

NationalInstruments.SemiconductorTestLibrary.Extensions.dll

ForceVoltage(DCPowerSessionsBundle, double, double?, double?, double?, bool)

Forces voltage 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 current limit, current limit range, voltage level range values directly.

public static void ForceVoltage(this DCPowerSessionsBundle sessionsBundle, double voltageLevel, double? currentLimit = null, double? voltageLevelRange = null, double? currentLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

voltageLevel double

The voltage level to force.

currentLimit double?

The current limit to use.

voltageLevelRange double?

The voltage level range to use.

currentLimitRange double?

The current 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.

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

Forces voltage 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 current limit, current limit range, voltage level range values directly.

public static void ForceVoltage(this DCPowerSessionsBundle sessionsBundle, IDictionary<string, double> voltageLevels, double? currentLimit = null, double? voltageLevelRange = null, double? currentLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

voltageLevels IDictionary<string, double>

The voltage levels to force for different pins.

currentLimit double?

The current limit to use.

voltageLevelRange double?

The voltage level range to use.

currentLimitRange double?

The current 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.

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

Forces voltage 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 current limit, current limit range, voltage level range values directly.

public static void ForceVoltage(this DCPowerSessionsBundle sessionsBundle, SiteData<double> voltageLevels, double? currentLimit = null, double? voltageLevelRange = null, double? currentLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

voltageLevels SiteData<double>

The voltage levels to force for different sites.

currentLimit double?

The current limit to use.

voltageLevelRange double?

The voltage level range to use.

currentLimitRange double?

The current 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.

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

Forces voltage 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 current limit, current limit range, voltage level range values directly.

public static void ForceVoltage(this DCPowerSessionsBundle sessionsBundle, PinSiteData<double> voltageLevels, double? currentLimit = null, double? voltageLevelRange = null, double? currentLimitRange = null, bool waitForSourceCompletion = false)

Parameters

sessionsBundle DCPowerSessionsBundle

The DCPowerSessionsBundle object.

voltageLevels PinSiteData<double>

The voltage levels to force for different site-pin pairs.

currentLimit double?

The current limit to use.

voltageLevelRange double?

The voltage level range to use.

currentLimitRange double?

The current 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.

ForceVoltage(DCPowerSessionsBundle, DCPowerSourceSettings, bool)

Forces voltage using specified source settings.

public static void ForceVoltage(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.

ForceVoltage(DCPowerSessionsBundle, SiteData<DCPowerSourceSettings>, bool)

Forces voltage using specified site-unique source settings.

public static void ForceVoltage(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.

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

Forces voltage using specified pin-unique source settings.

public static void ForceVoltage(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.

ForceVoltage(DCPowerSessionsBundle, PinSiteData<DCPowerSourceSettings>, bool)

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

public static void ForceVoltage(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.