Method LoadTDROffsetsFromFile
- 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
sessionsBundleDigitalSessionsBundle-
The NationalInstruments.SemiconductorTestLibrary.InstrumentAbstraction.Digital.DigitalSessionsBundle object.
filePathstring-
The path of the file to load the offsets.
throwOnMissingChannelsbool-
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
sessionsBundleDigitalSessionsBundle-
The NationalInstruments.SemiconductorTestLibrary.InstrumentAbstraction.Digital.DigitalSessionsBundle object.
filePathstring-
The path of the file to load the offsets.
offsetsPrecisionTimeSpan[][]-
TDR offset values retrieved from the file. Where the first dimension represents instrument sessions and the second dimension represents pins.
throwOnMissingChannelsbool-
Whether to throw a message if the offset for any channel is missing.
Remarks
This method supports loading files in the following formats:
- Files with offsets for filtered channels only (primary and non-shared channels)
- Files with offsets for all site-pin channels (including shadow channels of shared channels)
When loading from mode (2), shared channels must have consistent offset values across all their aliases.
Exceptions
- ArgumentException
-
This exception is 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.
- NISemiconductorTestException
-
This exception is thrown if shared channel offsets are inconsistent (different offset values for the same shared channel across different site-pin aliases).