Table of Contents

Class DcvsPins

Namespace
Tol
Assembly
Tol.dll
[Serializable]
public class DcvsPins : IDcvsPins, IPins<IDcvsPins>
Inheritance
DcvsPins
Implements
Inherited Members

Constructors

DcvsPins(string)

public DcvsPins(string pinList)

Parameters

pinList string

DcvsPins(string, DriverDCVSPins)

public DcvsPins(string pinList, DriverDCVSPins driverDCVSPins)

Parameters

pinList string
driverDCVSPins DriverDCVSPins

Properties

Bandwidth

The DCVS bandwidth setting.

public IValuePerSiteRange<double> Bandwidth { get; }

Property Value

IValuePerSiteRange<double>

Current

The DCVS force or clamp current.

public IValuePerSite<double> Current { get; }

Property Value

IValuePerSite<double>

CurrentRange

The DCVS current range.

public IValuePerSiteRange<double> CurrentRange { get; }

Property Value

IValuePerSiteRange<double>

Gate

The DCVS gate state.

public IValuePerSite<bool> Gate { get; }

Property Value

IValuePerSite<bool>

HardwareApi

Handle to legacy IG-XL object.

public DriverDCVSPins HardwareApi { get; }

Property Value

DriverDCVSPins

Meter

Gets the DCVI meter properties.

public IDcvsMeter Meter { get; }

Property Value

IDcvsMeter

Mode

The DCVS force mode settings, e.g. Voltage, Current.

public IValuePerSite<tlDCVSMode> Mode { get; }

Property Value

IValuePerSite<tlDCVSMode>

Name

Gets the name of the pin, pin group or comma separated pin list.

public string Name { get; }

Property Value

string

Voltage

The DCVS force or clamp voltage.

public IValuePerSiteRange<double> Voltage { get; }

Property Value

IValuePerSiteRange<double>

VoltageRange

The DCVS voltage range.

public IValuePerSiteRange<double> VoltageRange { get; }

Property Value

IValuePerSiteRange<double>

Methods

Connect(bool?)

Connects the specified DUT pins to the DCVS.

public virtual void Connect(bool? gate = null)

Parameters

gate bool?

Optional. The gate state after setting.

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

Creates a capture signal with the specified parameters.

public void CreateCaptureSignal(string signalName, tlDCVSMeterMode mode, double range, double sampleRate, int sampleSize, bool loadSettings = true)

Parameters

signalName string

The signal name of the capture signal.

mode tlDCVSMeterMode

mode of the capture signal.

range double

The range of the capture signal.

sampleRate double

The sample rate of the capture signal. HSVM is enabled by setting the sampleRate > 1.2 (UVS64-HP only).

sampleSize int

The sample size of the capture signal.

loadSettings bool

Optional. To load settings after configuring settings for the capture signal.

Disconnect(bool?)

Disconnects the specified DUT pins from the DCVS.

public virtual void Disconnect(bool? gate = null)

Parameters

gate bool?

Optional. The gate state after setting.

ForceHiZ()

Sets the DCVS to high impedance mode.

public void ForceHiZ()

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

Sets the force current, changing its force mode.

public void ForceI(double forceCurrent, double? clampVoltage = null, double? currentRange = null, double? voltageRange = null, bool setCurrentMode = true, bool? gate = null)

Parameters

forceCurrent double

The current to force.

clampVoltage double?

Optional. The voltage to clamp.

currentRange double?

Optional. The current range for measurement.

voltageRange double?

Optional. The voltage range.

setCurrentMode bool

Optional. To set the force mode to current.

gate bool?

Optional. The gate state after setting.

ForceISetMeterI(double, double, double, double, bool?)

Sets the Force current, and configures the meter to measure current.

public void ForceISetMeterI(double forceCurrent, double clampVoltage, double measureCurrentRange, double forceCurrentRange, bool? gate = null)

Parameters

forceCurrent double

The current to force.

clampVoltage double

The voltage to clamp.

measureCurrentRange double

The current range for measurement.

forceCurrentRange double

The current range for forcing.

gate bool?

Optional. The gate state after setting.

ForceISetMeterV(double, double, double, bool?)

Sets the Force current, and configures the meter to measure voltage.

public void ForceISetMeterV(double forceCurrent, double clampVoltage, double forceCurrentRange, bool? gate = null)

Parameters

forceCurrent double

The current to force.

clampVoltage double

The voltage to clamp.

forceCurrentRange double

The current range for forcing.

gate bool?

Optional. The gate state after setting.

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

Sets the force voltage, changing its force mode.

public void ForceV(double forceVoltage, double? clampCurrent = null, double? voltageRange = null, double? currentRange = null, bool setVoltageMode = false, bool? gate = null)

Parameters

forceVoltage double

The voltage to force.

clampCurrent double?

Optional. The current to clamp.

voltageRange double?

Optional. The voltage range.

currentRange double?

Optional. The current range.

setVoltageMode bool

Optional. To set the force mode to voltage.

gate bool?

Optional. The gate state after setting.

ForceVSetMeterI(double, double, double, bool?)

Sets the Force voltage, and configures the meter to measure current.

public void ForceVSetMeterI(double forceVoltage, double clampCurrent, double measureCurrentRange, bool? gate = null)

Parameters

forceVoltage double

The voltage to force.

clampCurrent double

The current to clamp.

measureCurrentRange double

The current range for measurement.

gate bool?

Optional. The gate state after setting.

ForceVSetMeterV(double, double, double, bool?)

Sets the Force voltage, and configures the meter to measure voltage.

public void ForceVSetMeterV(double forceVoltage, double clampCurrent, double measureVoltageRange, bool? gate = null)

Parameters

forceVoltage double

The voltage to force.

clampCurrent double

The current to clamp.

measureVoltageRange double

The voltage range for measurement.

gate bool?

Optional. The gate state after setting.

GetIndividualPins()

Gets the individual pins (array of single pins).

public IDcvsPins[] GetIndividualPins()

Returns

IDcvsPins[]

Returns an array of single pins.

GetPinListItem()

Gets the pin list item (array of pins as a single item).

public IDcvsPins[] GetPinListItem()

Returns

IDcvsPins[]

Returns an array of pins as single item.

Measure(int, double)

Performs measurement(s) on the DCVS, returning the average of measured value(s).

public PinSite<double> Measure(int sampleSize = 1, double sampleRate = -1)

Parameters

sampleSize int

Optional. The number of samples.

sampleRate double

Optional. The sample rate for the measurement, defaults to fastest sampling rate of first pin.

Returns

PinSite<double>

Returns the average of those measured samples.

MeasureSamples(int, double)

Performs measurement(s) on the DCVS, returning the measured samples.

public PinSite<Samples<double>> MeasureSamples(int sampleSize, double sampleRate = -1)

Parameters

sampleSize int

The number of samples.

sampleRate double

Optional. The sample rate for the measurement, defaults to fastest sampling rate of first pin.

Returns

PinSite<Samples<double>>

Returns the measured samples.

Read(int, double)

Reads the DCVS measurement values, from previous strobes.

public PinSite<double> Read(int sampleSize = 1, double sampleRate = -1)

Parameters

sampleSize int

Optional. The number of samples to average.

sampleRate double

Optional. The sample rate for the measurement, defaults to fastest sampling rate of first pin.

Returns

PinSite<double>

Returns the average of those measured samples.

ReadSamples(int, double)

Reads the DCVS measurement samples, from previous strobes.

public PinSite<Samples<double>> ReadSamples(int sampleSize, double sampleRate = -1)

Parameters

sampleSize int

The number of samples.

sampleRate double

Optional. The sample rate for the measurement, defaults to fastest sampling rate of first pin.

Returns

PinSite<Samples<double>>

Returns the measured samples.

ReadSignal(string)

Read the DCVS measurement value for the specified signal.

public PinSite<Samples<double>> ReadSignal(string signalName)

Parameters

signalName string

Returns

PinSite<Samples<double>>

Returns the measured samples for the specified signal.

SetCurrentRanges(double, double)

Sets the force and meter current ranges.

public void SetCurrentRanges(double forceRange, double meterRange)

Parameters

forceRange double

The force current range.

meterRange double

The meter current range.

SetMeterI(double?, double?, double?)

Sets the Meter to current mode.

public void SetMeterI(double? currentRange = null, double? filter = null, double? outputRange = null)

Parameters

currentRange double?

Optional. The current range for measurement.

filter double?

Optional. Specifies the filter bandwidth, which attenuates high-frequency noise.

outputRange double?

SetMeterV(double?)

Sets the Meter to voltage mode.

public void SetMeterV(double? filter = null)

Parameters

filter double?

Optional. Specifies the filter bandwidth, which attenuates high-frequency noise.

Strobe(int, double)

Performs multiple measurements (strobes) on the DCVS, to read back the values later.

public void Strobe(int sampleSize = 1, double sampleRate = -1)

Parameters

sampleSize int

Optional. The number of samples.

sampleRate double

Optional. The sample rate for the measurement, defaults to fastest sampling rate of first pin.