NI-Digital Pattern Driver .NET Class Library

Table of Contents

DigitalDriverUtility.SortSiteResultsBySite Method (NIDigital[], String, SiteResultType, UInt32[][][], Int32[])

  • Updated2023-11-24
  • 2 minute(s) read
DigitalDriverUtility.SortSiteResultsBySite Method (NIDigital[], String, SiteResultType, UInt32[][][], Int32[])

DigitalDriverUtilitySortSiteResultsBySite Method (NIDigital, String, SiteResultType, UInt32, Int32)

Orders site data read from multiple instruments to match the site list you specify, and combines data from instruments mapped to the same site.

Namespace:  NationalInstruments.ModularInstruments.NIDigital
Assembly:  NationalInstruments.ModularInstruments.NIDigital.Fx40 (in NationalInstruments.ModularInstruments.NIDigital.Fx40.dll) Version: 2021

Syntax

public static uint[][] SortSiteResultsBySite(
	NIDigital[] sessions,
	string siteList,
	SiteResultType siteResultType,
	uint[][][] waveformsToSort,
	out int[] siteNumbers
)
Public Shared Function SortSiteResultsBySite ( 
	sessions As NIDigital(),
	siteList As String,
	siteResultType As SiteResultType,
	waveformsToSort As UInteger()()(),
	<OutAttribute> ByRef siteNumbers As Integer()
) As UInteger()()

Parameters

sessions
Type: NationalInstruments.ModularInstruments.NIDigitalNIDigital
The instrument sessions to return data for.
siteList
Type: SystemString
The comma-delimited list of strings of form site N, where N is the site number.
siteResultType
Type: NationalInstruments.ModularInstruments.NIDigitalSiteResultType
The type of data in the results array.
waveformsToSort
Type: SystemUInt32
The waveform data to read from the digital pattern instruments.
siteNumbers
Type: SystemInt32
An array of site numbers corresponding to the values in DUT pin results.

Return Value

Type: UInt32
Returns the sorted and merged results.

Remarks

Each instrument returns data using the Fetch(String, String, Int32, TimeSpan, UInt32) method for the enabled sites on which the instrument is configured to capture waveforms. Disabled sites return an empty array. The method returns the sorted results in the same order as the captured waveforms.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Log in to get a better experience