Interface ILib.IAcquire.IDc

Namespace

Csra.Interfaces

Assembly

Csra.dll

The interface for the Dc branch.

public interface ILib.IAcquire.IDc

Methods

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

Performs multiple measurements for the set of pins provided.

PinSite<double> Measure(Pins pins, int sampleSize, double? sampleRate = null, DcMeterMode? meterMode = null)

Parameters

pins Pins

The pins to measure.

sampleSize int

The number of samples.

sampleRate double?

Optional. The sampling rate.

meterMode DcMeterMode?

Optional. Set the meter mode to Voltage or Current.

Returns

PinSite<double>

Returns an average value.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

Measure(Pins, DcMeterMode?)

Performs a single measurement for the set of pins provided.

PinSite<double> Measure(Pins pins, DcMeterMode? meterMode = null)

Parameters

pins Pins

The pins to measure.

meterMode DcMeterMode?

Optional. Set the meter mode to Voltage or Current.

Returns

PinSite<double>

Returns a value.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

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

Performs multiple measurements for the set of each element in pinGroups.

PinSite<double> Measure(Pins[] pinGroups, int[] sampleSizes, double[] sampleRates = null, DcMeterMode[] meterModes = null)

Parameters

pinGroups Pins[]

Array of pin or pin groups.

sampleSizes int[]

Array of number of samples.

sampleRates double[]

Optional. Array of sampling rate.

meterModes DcMeterMode[]

Optional. Array of settings measurements mode voltage and current.

Returns

PinSite<double>

Returns a set of measurements.

Exceptions

Exception

Appears when an element of pinGroups contains different types of pins - temporary limitation in functionality.

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

Performs multiple measurements for the set of pins provided.

PinSite<Samples<double>> MeasureSamples(Pins pins, int sampleSize, double? sampleRate = null, DcMeterMode? meterMode = null)

Parameters

pins Pins

The pins to measure.

sampleSize int

The number of samples.

sampleRate double?

Optional. The sampling rate.

meterMode DcMeterMode?

Optional. Set the meter mode to Voltage or Current.

Returns

PinSite<Samples<double>>

Returns a set of measurements.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

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

Performs multiple measurements for the set of each element in pinGroups.

PinSite<Samples<double>> MeasureSamples(Pins[] pinGroups, int[] sampleSizes, double[] sampleRates = null, DcMeterMode[] meterModes = null)

Parameters

pinGroups Pins[]

Array of pin or pin groups.

sampleSizes int[]

Array of number of samples.

sampleRates double[]

Optional. Array of sampling rate.

meterModes DcMeterMode[]

Optional. Array of settings measurements mode voltage and current.

Returns

PinSite<Samples<double>>

Returns a set of measurements.

Exceptions

Exception

Appears when an element of pinGroups contains different types of pins - temporary limitation in functionality.

ReadCaptured(Pins, string)

Allows configuration and control of capture parameters for the specified pins.

PinSite<double> ReadCaptured(Pins pins, string signalName)

Parameters

pins Pins

List of pin or pin group names.

signalName string

The name of the read signal.

Returns

PinSite<double>

Returns a value.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

ReadCapturedSamples(Pins, string)

Allows configuration and control of capture parameters for the specified pins.

PinSite<Samples<double>> ReadCapturedSamples(Pins pins, string signalName)

Parameters

pins Pins

List of pin or pin group names.

signalName string

The name of the read signal.

Returns

PinSite<Samples<double>>

Returns a set of measurements.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

ReadMeasured(Pins, int, double?)

Performs multiple readings of measurements, depending on the sample size parameter, for the set of pins provided.

PinSite<double> ReadMeasured(Pins pins, int sampleSize, double? sampleRate = null)

Parameters

pins Pins

The pins to read measurements.

sampleSize int

The number of samples.

sampleRate double?

Optional. The sampling rate.

Returns

PinSite<double>

Returns an average value.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

ReadMeasuredSamples(Pins, int, double?)

Performs multiple readings of measurements, depending on the sample size parameter, for the set of pins provided.

PinSite<Samples<double>> ReadMeasuredSamples(Pins pins, int sampleSize, double? sampleRate = null)

Parameters

pins Pins

The pins to read measurements.

sampleSize int

The number of samples.

sampleRate double?

Optional. The sampling rate.

Returns

PinSite<Samples<double>>

Returns a set of measurements.

Exceptions

Exception

Appears when pinList contains different types of pins - temporary limitation in functionality.

Strobe(Pins)

Performs a single measurement (strobe) on the according instrument, to read back the value later.

void Strobe(Pins pins)

Parameters

pins Pins

The pins to be measured.

StrobeSamples(Pins, int, double?)

Performs multiple measurements (strobes) on the according instrument, to read back the value later.

void StrobeSamples(Pins pins, int sampleSize, double? sampleRate = null)

Parameters

pins Pins

The pins to be measured.

sampleSize int

Number of measurements (Strobes).Ignored for PPMU.

sampleRate double?

Optional. The sampling rate. Default is the current hardware setting. Ignored for PPMU.