NIDigital Class
- Updated2023-11-24
- 6 minute(s) read
NIDigital Class
Represents a digital pattern instrument session.
Inheritance Hierarchy
Namespace: NationalInstruments.ModularInstruments.NIDigital
Assembly: NationalInstruments.ModularInstruments.NIDigital.Fx40 (in NationalInstruments.ModularInstruments.NIDigital.Fx40.dll) Version: 2021
Syntax
public sealed class NIDigital : IDisposable, IServiceProvider, IIviDriver, ITClockSynchronizableDevice
Public NotInheritable Class NIDigital Implements IDisposable, IServiceProvider, IIviDriver, ITClockSynchronizableDevice
The NIDigital type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | NIDigital(IntPtr) |
Initializes a new instance of the NIDigital class. Initializes an instrument driver session from an existing instrument handle.
|
| NIDigital(String, Boolean, Boolean) |
Initializes a new instance of the NIDigital class. Initializes a digital pattern instrument driver session and sets the initial state of session properties.
|
| NIDigital(String, Boolean, Boolean, String) |
Initializes a new instance of the NIDigital class. This overload is reserved for future use.
|
Properties
| Name | Description | |
|---|---|---|
 | CaptureWaveforms |
Gets the DigitalCaptureWaveforms object containing methods for creating and fetching capture waveforms.
|
| DriverOperation |
Gets the DigitalDriverOperation object containing methods and properties that manage the operation of the driver.
|
| Event |
Gets the DigitalEvent object that contains the events for the NIDigital session.
|
| HistoryRam |
Gets the DigitalHistoryRam object containing methods for configuring and fetching History RAM contents.
|
| Identity |
Gets the DigitalDriverIdentity object, which contains properties that return information about the
identity of the NI-Digital Pattern Driver software.
|
| IsDisposed |
Gets a value indicating whether the NIDigital session has been disposed.
|
| NumberOfChannels |
Gets the number of channels on the digital pattern instrument.
|
| PatternControl |
Gets the DigitalPatternControl control object, containing properties and methods for setting up and bursting a pattern.
|
| PinAndChannelMap |
Gets the DigitalPinAndChannelMap object that stores all the pin mapping information for the NIDigital session.
|
| SourceWaveforms |
Gets the DigitalSourceWaveforms object containing the functionality for creating and writing source waveforms.
|
| Timing |
Gets the DigitalTiming object that stores the time sets for the NIDigital session.
|
| Trigger |
Gets the DigitalTrigger object that contains the triggers for the NIDigital session.
|
| Utility |
Gets the DigitalDriverUtility object containing methods providing utility operations for the NI-Digital Pattern Driver.
|
Methods
| Name | Description | |
|---|---|---|
| ApplyLevelsAndTiming(String, String, String) |
Applies digital levels and timing defined in the loaded levels and timing sheets.
|
| ApplyLevelsAndTiming(String, String, String, DigitalPinSet, DigitalPinSet, DigitalPinSet) |
Applies digital levels and timing defined in the loaded levels and timing sheets.
|
| ApplyLevelsAndTiming(String, String, String, String, String, String) |
Applies digital levels and timing defined in the loaded levels and timing sheets.
|
| Close |
Closes the session with the digital pattern instrument.
|
| DisableSites |
Disables the specified sites.
|
| Dispose |
Disposes the NIDigital session.
|
| EnableSites |
Enables the specified sites.
|
| Equals | (Inherited from Object.) |
| ExportSignal |
Routes trigger and event signals to the specified outputTerminal.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetInstrumentHandle |
Gets the SafeHandle to the NIDigital instrument session.
|
| GetService |
Gets the service object of the specified type.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsSiteEnabled |
Returns whether the specified site is enabled or disabled.
|
| LoadLevels(IEnumerableString) |
Loads levels sheets from a list of pin levels files.
|
| LoadLevels(String) |
Loads a levels sheet from file.
|
| LoadPattern |
Loads a pattern to the hardware from a pattern file.
|
| LoadPinMap |
Loads a pin map file.
|
| LoadSpecifications(IEnumerableString) |
Loads specifications sheets from a list of specifications files.
|
| LoadSpecifications(String) |
Loads a specifications sheet from file.
|
| LoadTiming(IEnumerableString) |
Loads one or more time sets from a list of timing sheet files.
|
| LoadTiming(String) |
Loads one or more time sets from a timing sheet file.
|
| SelfCalibrate |
Performs a self-calibration on a digital pattern instrument. This operation may take several minutes to complete.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnloadAllPatterns |
Unloads all patterns, source waveforms, and capture waveforms from a digital pattern instrument.
|
| UnloadSpecifications(IEnumerableString) |
Unloads the given specifications sheets present in the previously loaded specifications files that you select.
|
| UnloadSpecifications(String) |
Unloads the given specifications sheet present in the previously loaded specifications file that you select.
|
Remarks
Use this class to configure and control your digital pattern instrument.
 Tip |
|---|
| Example applications are located in the Public Documents\National Instruments\NI-Digital\Examples\DotNET 4.x directory or in the Start menu at National InstrumentsNI Digital Pattern Examples. |
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.