NI-Digital Pattern Driver .NET Class Library

Table of Contents

DigitalPatternControl.BurstPattern Method (String, String, Boolean, TimeSpan)

  • Updated2023-11-24
  • 2 minute(s) read
DigitalPatternControl.BurstPattern Method (String, String, Boolean, TimeSpan)

DigitalPatternControlBurstPattern Method (String, String, Boolean, TimeSpan)

Bursts the pattern on the sites you specify, waits for the burst to complete, and returns comparison results for each site.

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

Syntax

public bool[] BurstPattern(
	string siteList,
	string startLabel,
	bool selectDigitalFunction,
	TimeSpan maxTime
)
Public Function BurstPattern ( 
	siteList As String,
	startLabel As String,
	selectDigitalFunction As Boolean,
	maxTime As TimeSpan
) As Boolean()

Parameters

siteList
Type: SystemString
The sites on which to burst the pattern as a comma-delimited list of strings of the form siteN, where N is the site number. If you specify an empty string, the pattern is burst on all sites.
startLabel
Type: SystemString
The pattern name or exported pattern label from which to start bursting the pattern.
selectDigitalFunction
Type: SystemBoolean
If , sets the SelectedFunction of the pins to Digital.
maxTime
Type: SystemTimeSpan
The maximum time interval allowed for the pattern burst to complete.

Return Value

Type: Boolean
An array of Boolean values for each site. , if the site passed; , if the site failed. If a site is disabled or not enabled for burst, the method does not return data for that site. Use SortSiteResultsBySite(NIDigital, String, SiteResultType, Boolean, Int32) to order and combine the data to match siteList . You can also use GetSiteResultsSiteNumbers(String, SiteResultType) to obtain a sorted list of returned sites.

Exceptions

ExceptionCondition
IviCDriverExceptionThe NI-Digital Pattern Driver returned an error.
InvalidOperationExceptionBurstPattern(String, String, Boolean, TimeSpan) is called without loading a pattern.
SelectorNameExceptionThe value for siteList contains an invalid site.
MaxTimeExceededExceptionThe pattern burst took longer than the specified maxTime.
ArgumentExceptionOne or more of the configured properties of the underlying NI-Digital Pattern Driver were invalid.

Remarks

Digital pins retain their state at the end of a pattern burst until the first vector of the pattern burst, a call to WriteStatic(PinState), or a call to ApplyLevelsAndTiming(String, String, String).

This overload will burst the pattern to completion and then return the site pass/fail results. Call this overload when you want to wait until the pattern burst is complete before continuing program execution.

For more information, refer to the Session State Model topic of the Digital Pattern Help.

See Also

Log in to get a better experience