Method LoadTDROffsetsFromFile

Namespace

NationalInstruments.SemiconductorTestLibrary.InstrumentAbstraction.Digital

Assembly

NationalInstruments.SemiconductorTestLibrary.Extensions.dll

LoadTDROffsetsFromFile(DigitalSessionsBundle, string, bool)

Loads TDR offsets from a file.

public static PinSiteData<PrecisionTimeSpan> LoadTDROffsetsFromFile(this DigitalSessionsBundle sessionsBundle, string filePath, bool throwOnMissingChannels = true)

Parameters

sessionsBundle DigitalSessionsBundle

The DigitalSessionsBundle object.

filePath string

The path of the file to load the offsets.

throwOnMissingChannels bool

Whether to throw an exception if the offset for any channel is missing.

Returns

PinSiteData<PrecisionTimeSpan>

TDR offset values retrieved from the file.

Exceptions

ArgumentException

This exception will be thrown if throwOnMissingChannels is true and an offset value was not found in the file for one or more of channels in the sessions bundle.

LoadTDROffsetsFromFile(DigitalSessionsBundle, string, out PrecisionTimeSpan[][], bool)

Loads TDR offsets from a file.

public static void LoadTDROffsetsFromFile(this DigitalSessionsBundle sessionsBundle, string filePath, out PrecisionTimeSpan[][] offsets, bool throwOnMissingChannels = true)

Parameters

sessionsBundle DigitalSessionsBundle

The DigitalSessionsBundle object.

filePath string

The path of the file to load the offsets.

offsets PrecisionTimeSpan[][]

TDR offset values retrieved from the file. Where the first dimension represents instrument sessions and the second dimension represents pins.

throwOnMissingChannels bool

Whether to throw a message if the offset for any channel is missing.

Exceptions

ArgumentException

This exception will be thrown if throwOnMissingChannels is true and an offset value was not found in the file for one or more of channels in the sessions bundle.