DigitalPatternControl Class
- Updated2026-01-12
- 2 minute(s) read
Provides the controls for setting up and bursting a pattern.
Derives from
Syntax
Namespace: NationalInstruments.ModularInstruments.NIDigital
public class DigitalPatternControl : DigitalSubObject
Remarks
Example applications are located in the <Public Documents>\National Instruments\NI-Digital\Examples\DotNET 4.x directory or in the Start menu at National Instruments » NI Digital Pattern Examples.
Thread Safety
All members of this type are safe for multithreaded operations.
Properties
| Name | Description |
|---|---|
| HaltOnKeepAliveOpcode | Gets or sets a value that indicates whether keep_alive opcodes should behave like halt opcodes. |
| IsDone | Gets a value that indicates whether the pattern burst completed or if any errors have occurred. |
| IsKeepAliveActive | Gets a value that indicates whether the instrument is driving a keep alive pattern. |
| StartLabel | Gets or sets the pattern name or exported pattern label from which to start bursting the pattern. |
Methods
| Name | Description |
|---|---|
| BurstPatternSynchronized(NIDigital[], string, string, bool, bool, TimeSpan) | Starts a pattern burst on digital pattern instruments that you have previously synchronized using NI-TClk. |
| EnableMatchFailCombination(ITClockSynchronizableDevice[], IntPtr) | Configures digital pattern instruments as well as the timing and synchronization instrument (PXIe-6674T) to combine pattern comparison results and control subsequent pattern execution across digital pattern instruments based on those results. |
| WriteSequencerFlagSynchronized(NIDigital[], string, bool) | Writes a Boolean value to a specified pattern sequencer flag for synchronized instruments. Use pattern sequencer flags to coordinate execution between the pattern sequencer and a run-time program. |
| Abort() | Stops bursting the pattern. |
| AbortKeepAlive() | Stops the keep alive pattern if it is currently running. |
| BurstPattern(string, string, bool, bool, TimeSpan) | Starts a pattern burst and optionally blocks program execution until the pattern burst is complete. |
| BurstPattern(string, string, bool, TimeSpan) | Bursts the pattern on the sites you specify, waits for the burst to complete, and returns comparison results for each site. |
| Commit() | Applies all previously configured pin levels, termination modes, clocks, triggers, and pattern timing to a digital pattern instrument. Calling this method moves the session from the Uncommitted state to the Committed state. |
| ConfigurePatternBurstSites(string) | Configures which sites will be burst on the next call of Initiate. |
| EnableMatchFailCombination(IntPtr) | Configures multiple digital pattern instruments in the session as well as the timing and synchronization instrument (PXIe-6674T) to combine pattern comparison results and control subsequent pattern execution across all digital pattern instruments in the session, based on those results. |
| GetPatternPinSet(string) | Gets the pins referenced by a pattern, as a pin set. |
| GetPatternPinSetString(string) | Gets the pins referenced by a pattern, as a string. |
| GetSitePassFail(string) | Returns a value indicating whether the specified sites passed the comparisons in the pattern burst. |
| Initiate() | Starts bursting pattern. |
| ReadSequencerFlag(string) | Reads the System.Boolean state of a pattern sequencer flag. |
| ReadSequencerRegister(string) | Reads the numeric state of a pattern sequencer register. |
| WaitUntilDone(TimeSpan) | Waits until the pattern burst has completed or the specified maxTime has expired. |
| WriteSequencerFlag(string, bool) | Writes a System.Boolean value to a pattern sequencer flag. |
| WriteSequencerRegister(string, int) | Writes a value to a pattern sequencer register. |