Class DcviPins

Namespace

Tol

Assembly

Tol.dll

[Serializable]
public class DcviPins : IDcviPins, IPins<IDcviPins>

Inheritance

object

DcviPins

Implements

IDcviPins

IPins<IDcviPins>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Bandwidth

The DCVI bandwidth setting.

public IValuePerSiteRange<double> Bandwidth { get; }

Property Value

IValuePerSiteRange<double>

ComplianceRangeNegative

The DCVI negative compliance range.

public IValuePerSiteRange<double> ComplianceRangeNegative { get; }

Property Value

IValuePerSiteRange<double>

ComplianceRangePositive

The DCVI positive compliance range.

public IValuePerSiteRange<double> ComplianceRangePositive { get; }

Property Value

IValuePerSiteRange<double>

Current

The DCVI force or clamp current.

public IValuePerSite<double> Current { get; }

Property Value

IValuePerSite<double>

CurrentRange

The DCVI current range.

public IValuePerSiteRange<double> CurrentRange { get; }

Property Value

IValuePerSiteRange<double>

Gate

The DCVI gate state.

public IValuePerSite<tlDCVGate> Gate { get; }

Property Value

IValuePerSite<tlDCVGate>

HardwareApi

Handle to legacy IG-XL object.

public DriverDCVIPins HardwareApi { get; }

Property Value

DriverDCVIPins

Meter

Gets the DCVI meter properties.

public IDcviMeter Meter { get; }

Property Value

IDcviMeter

Mode

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

public IValuePerSite<tlDCVIMode> Mode { get; }

Property Value

IValuePerSite<tlDCVIMode>

Name

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

public string Name { get; }

Property Value

string

Voltage

The DCVI force or clamp voltage.

public IValuePerSite<double> Voltage { get; }

Property Value

IValuePerSite<double>

VoltageRange

The DCVI voltage range.

public IValuePerSiteRange<double> VoltageRange { get; }

Property Value

IValuePerSiteRange<double>

Methods

Connect(bool?)

Connects the specified DUT pins to the DCVI.

public virtual void Connect(bool? gate = null)

Parameters

gate bool?

Optional. The gate state after setting.

Disconnect(bool?)

Disconnects the specified DUT pins from the DCVI.

public virtual void Disconnect(bool? gate = null)

Parameters

gate bool?

Optional. The gate state after setting.

ForceHiZ()

Sets the DCVI 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?

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 to force.

gate bool?

Optional. The gate state after setting.

ForceISetMeterV(double, double, double, double, bool?)

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

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

Parameters

forceCurrent double

The current to force.

clampVoltage double

The voltage to clamp.

measureVoltageRange double

The voltage range for measurement.

forceCurrentRange double

The current range to force.

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 = true, bool? gate = null)

Parameters

forceVoltage double

The voltage to force.

clampCurrent double?

Optional. The current for the clamp.

voltageRange double?

Optional. The voltage range for measurement.

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 IDcviPins[] GetIndividualPins()

Returns

IDcviPins[]

Returns an array of single pins.

GetPinListItem()

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

public IDcviPins[] GetPinListItem()

Returns

IDcviPins[]

Returns an array of pins as single item.

Measure(int, double)

Performs measurement(s) on the DCVI, 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 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.

MeasureSamples(int, double)

Performs measurement(s) on the DCVI, 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 DCVI measurement value, from previous strobe.

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 DCVI measurement samples, from previous strobe.

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

SetCurrentAndRange(double, double)

Sets the current and current range.

public void SetCurrentAndRange(double current, double currentRange)

Parameters

current double

The current to force.

currentRange double

The current range for measurement.

SetMeterI(double?, int?, double?)

Sets the meter to current mode.

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

Parameters

currentRange double?

Optional. The current range for measurement.

hardwareAverage int?

Optional. Samples to average in hardware.

filter double?

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

SetMeterV(double?, int?, double?)

Sets the meter to voltage mode.

public void SetMeterV(double? voltageRange = null, int? hardwareAverage = null, double? filter = null)

Parameters

voltageRange double?

Optional. The voltage range for measurement.

hardwareAverage int?

Optional. Samples to average in hardware.

filter double?

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

SetVoltageAndRange(double, double)

Sets the voltage and voltage range.

public void SetVoltageAndRange(double voltage, double voltageRange)

Parameters

voltage double

The voltage to force.

voltageRange double

The voltage range for measurement.

Strobe(int, double)

Performs measurement(s) (strobe) on the DCVI, to read back the value(s) 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.