Interface ILib.ISetup.IDc

Namespace

Csra.Interfaces

Assembly

Csra.dll

The interface for the Dc branch.

public interface ILib.ISetup.IDc

Extension Methods

CustomerExtensions.CustomerExtension(ILib.ISetup.IDc, string, int)

Methods

Connect(Pins, bool)

Connects and optionally gates on/off the pins depending on its instrument feature (PPMU, DCVI, DCVS,...).

void Connect(Pins pins, bool gateOn = false)

Parameters

pins Pins

The pins to connect.

gateOn bool

Optional. Default no gate change, True for gate on the pins after connecting.

ConnectAllPins()

Connects all power and digital pins from level context.

void ConnectAllPins()

CreateCaptureSignal(Pins, string, tlDCVSMeterMode, double, double, int, bool)

Add capture signal to be acquired during the test execution.

void CreateCaptureSignal(Pins capturePin, string signalName, tlDCVSMeterMode meterMode, double range, double sampleRate, int sampleSize, bool loadSettings = true)

Parameters

capturePin Pins

Pin to be captured.

signalName string

Name of the signal.

meterMode tlDCVSMeterMode

Meter mode to set for capture signal.

range double

Range to set for the signal.

sampleRate double

Sample rate to capture for the signal.

sampleSize int

Sample size to capture for the signal.

loadSettings bool

Optional. Load settings after configuring the capture signal. True by default.

Disconnect(Pins, bool)

Disconnects and optionally gates on/off the pins depending on its instrument feature (PPMU, DCVI, DCVS,...). It will disconnect in HiZ mode rather then of forcing 0V or 0A on VIs.

void Disconnect(Pins pins, bool gateOff = true)

Parameters

pins Pins

The pins to disconnect.

gateOff bool

Optional. Default gate off (HiZ) the pins before disconnecting, False no gate change.

Force(Pins, DcOutputMode, double, double, double, bool)

Sets the force current, force voltage or high impedance of the pins.

void Force(Pins pins, DcOutputMode mode, double forceValue, double forceRange, double clampValue, bool gateOn = true)

Parameters

pins Pins

The pins to force.

mode DcOutputMode

The mode for forcing (e.g., Voltage or Current).

forceValue double

The value to force.

forceRange double

The range for force value.

clampValue double

When forcing Voltage it sets the current limit and when forcing Current it sets the voltage range.

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

Force(Pins[], DcOutputMode[], double[], double[], double[], bool[])

Sets the force current, force voltage or high impedance of each element in pinGroups.

void Force(Pins[] pinGroups, DcOutputMode[] modes, double[] forceValues, double[] forceRanges, double[] clampValues, bool[] gateOn = null)

Parameters

pinGroups Pins[]

Array of pin or pin groups.

modes DcOutputMode[]

Array of the mode for each pin or pin group.

forceValues double[]

Array of force values for each pin or pin group.

forceRanges double[]

Array of force ranges for each pin or pin group.

clampValues double[]

Array of clamp values for each pin or pin group.

gateOn bool[]

Optional. Array of gate state for each pin or pin group, default gate on for all pin or pin group.

ForceHiZ(Pins)

Sets to High Impedance mode.

void ForceHiZ(Pins pins)

Parameters

pins Pins

The pins to set in HiZ.

ForceI(Pins, double, double, double, double?, bool, bool, double?)

Sets the Force Current and the range of a DC instrument. Assuming that the instrument was already setup for remaining parameters.

void ForceI(Pins pins, double forceCurrent, double clampHiV, double currentRange, double? voltageRange = null, bool outputModeCurrent = false, bool gateOn = true, double? clampLoV = null)

Parameters

pins Pins

The pins to force the current.

forceCurrent double

The current to force.

clampHiV double

Sets the voltage for voltage clamp high.

currentRange double

Expected current to set the current range.

voltageRange double?

Optional. Expected voltage to set the voltage range or to program the voltage for DCVS.

outputModeCurrent bool

Optional. Sets to true to switch to force current mode (if the mode was not previously set).

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

clampLoV double?

Optional. Sets the voltage for voltage clamp low.

ForceI(Pins, double, double?, double?, bool, bool)

Sets the Force current of a DC instrument. Assumes the instrument was already setup to the right modes.

void ForceI(Pins pins, double forceCurrent, double? clampHiV = null, double? clampLoV = null, bool outputModeCurrent = false, bool gateOn = true)

Parameters

pins Pins

The pins to force the current.

forceCurrent double

The current to force.

clampHiV double?

Optional. Sets the voltage for voltage clamp high.

clampLoV double?

Optional. Sets the voltage for voltage clamp low.

outputModeCurrent bool

Optional. Sets to true to switch to force current mode (if the mode was not previously set).

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

ForceV(Pins, double, double, double, double?, bool, bool)

Programs the force Voltage, meter range and many other parameters of a DC instrument - Advanced method with additional parameters.

void ForceV(Pins pins, double forceVoltage, double clampCurrent, double voltageRange, double? currentRange = null, bool outputModeVoltage = false, bool gateOn = true)

Parameters

pins Pins

The pins to force the voltage.

forceVoltage double

The force voltage value.

clampCurrent double

Current clamp value.

voltageRange double

Expected voltage to set the Voltage range, if required, else use the forceVoltage.

currentRange double?

Optional. Expected current to set the current range.

outputModeVoltage bool

Optional. Sets to true to switch to force voltage mode (if the mode was not previously set).

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

ForceV(Pins, double, double?, bool, bool)

Programs the force Voltage of a DC instrument. Simplest Method: It assumes the instrument is already in the right mode (FI,FV) and required ranges.

void ForceV(Pins pins, double forceVoltage, double? clampCurrent = null, bool outputModeVoltage = false, bool gateOn = true)

Parameters

pins Pins

The pins to force the voltage.

forceVoltage double

The force voltage that will be set.

clampCurrent double?

Optional. Current clamp value.

outputModeVoltage bool

Optional. Sets to true to switch to force voltage mode (if the mode was not previously set).

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

Modify(Pins, DcParameters)

Selectively program or modify any DC instrument parameter.

void Modify(Pins pins, DcParameters parameters)

Parameters

pins Pins

The pins to set.

parameters DcParameters

The object through which each parameter can be set.

Modify(Pins, bool?, DcOutputMode?, double?, double?, double?, double?, double?, double?, DcMeterMode?, double?, double?, double?, double?, double?, double?, double?, bool?, bool?, double?, double?, double?, double?, double?, bool?, double?, double?)

Selectively program or modify any DC instrument parameter.

void Modify(Pins pins, bool? gate = null, DcOutputMode? mode = null, double? voltage = null, double? voltageAlt = null, double? current = null, double? voltageRange = null, double? currentRange = null, double? forceBandwidth = null, DcMeterMode? meterMode = null, double? meterVoltageRange = null, double? meterCurrentRange = null, double? meterBandwidth = null, double? sourceFoldLimit = null, double? sinkFoldLimit = null, double? sourceOverloadLimit = null, double? sinkOverloadLimit = null, bool? voltageAltOutput = null, bool? bleederResistor = null, double? complianceBoth = null, double? compliancePositive = null, double? complianceNegative = null, double? clampHiV = null, double? clampLoV = null, bool? highAccuracy = null, double? settlingTime = null, double? hardwareAverage = null)

Parameters

pins Pins

The pins to set.

gate bool?

Optional. Sets the gate.

mode DcOutputMode?

Optional. Sets the operating mode.

voltage double?

Optional. Sets the output voltage.

voltageAlt double?

Optional. Sets the alternate output voltage.

current double?

Optional. Sets the output current.

voltageRange double?

Optional. Sets the voltage range.

currentRange double?

Optional. Sets the current range.

forceBandwidth double?

Optional. Sets the output compensation bandwidth.

meterMode DcMeterMode?

Optional. Sets the meter mode.

meterVoltageRange double?

Optional. Sets the meter voltage range.

meterCurrentRange double?

Optional. Sets the meter current range.

meterBandwidth double?

Optional. Sets the meter filter.

sourceFoldLimit double?

Optional. Sets the source fold limit.

sinkFoldLimit double?

Optional. Sets the sink fold limit.

sourceOverloadLimit double?

Optional. Sets the source overload limit.

sinkOverloadLimit double?

Optional. Sets the sink overload limit.

voltageAltOutput bool?

Optional. Sets the output DAC used to force voltage (true for alternate or false for main).

bleederResistor bool?

Optional. Sets the bleeder resistor�s connection state.

complianceBoth double?

Optional. Sets both compliance ranges.

compliancePositive double?

Optional. Sets the positive compliance range.

complianceNegative double?

Optional. Sets the negative compliance range.

clampHiV double?

Optional. Sets the high voltage clamp value.

clampLoV double?

Optional. Sets the low voltage clamp value.

highAccuracy bool?

Optional. Sets the enabled state of the high accuracy measurement voltage.

settlingTime double?

Optional. Sets the required additional settling time for the high accuracy measurement voltage mode.

hardwareAverage double?

Optional. Sets the meter hardware average value.

SetForceAndMeter(Pins, DcOutputMode, double, double, double, DcMeterMode, double, bool)

Programs the force and the meter's measurement parameters interface for the dc instruments.

void SetForceAndMeter(Pins pins, DcOutputMode mode, double forceValue, double forceRange, double clampValue, DcMeterMode meterMode, double measureRange, bool gateOn = true)

Parameters

pins Pins

The pins to set force and meter parameters.

mode DcOutputMode

Set the output mode to DcOutputMode Voltage, Current or HiZ.

forceValue double

Force voltage or current value.

forceRange double

Voltage or current to set the force range.

clampValue double

Current or voltage clamp value. Note: For PPMU it programs either clampVHi or clampVLo depending if sourcing or sinking current.

meterMode DcMeterMode

Set the meter mode to voltage or current.

measureRange double

Set the meter's range to the expected current or voltage.

gateOn bool

Optional. Default gate on the pins after after the settings,False no gate change.

SetMeter(Pins, DcMeterMode, double?, double?, int?, double?)

Sets the measurement interface of the instruments DCVI and DCVS.

void SetMeter(Pins pins, DcMeterMode meterMode, double? rangeValue = null, double? filterValue = null, int? hardwareAverage = null, double? outputRangeValue = null)

Parameters

pins Pins

The pins to set meter parameters.

meterMode DcMeterMode

Set the meter mode to Voltage or Current.

rangeValue double?

Optional. Current or Voltage range depending on the selected mode.

filterValue double?

Optional. Sets the filter value.

hardwareAverage int?

Optional. Sets the hardware average for the specified DCVI pins.

outputRangeValue double?

Optional. Current range for DCVS when you want to set the current mode - for other cases, ignore this.

SetMeter(Pins[], DcMeterMode[], double[], double[], int[], double[])

Sets the measurements interface of the instruments DCVI and DCVS.

void SetMeter(Pins[] pinGroups, DcMeterMode[] meterModes, double[] rangeValues = null, double[] filterValues = null, int[] hardwareAverages = null, double[] outputRangeValues = null)

Parameters

pinGroups Pins[]

Array of pin or pin groups.

meterModes DcMeterMode[]

Array of settings measurements mode voltage and current.

rangeValues double[]

Optional. Array of current and voltage range depending on the selected modes.

filterValues double[]

Optional. Array of filter values.

hardwareAverages int[]

Optional. Array of hardware average for the specified DCVI pins.

outputRangeValues double[]

Optional. Array of current range for DCVS when you want to set the current mode - for other cases, ignore this.