Commit Method

NI Signal Generators Help (NI-FGEN 18.1)

Edition Date: April 2018

Part Number: 370524V-01

»View Product Info
Download Help (Windows Only)

NIFgen Class See Also


Causes a transition to the committed state.

Namespace: NationalInstruments.ModularInstruments.NIFgen

Assembly: NationalInstruments.ModularInstruments.NIFgen.Fx40 (in NationalInstruments.ModularInstruments.NIFgen.Fx40.dll) Version: 18.1.0.4 (18.1.0.4)

Syntax

Visual Basic (Declaration)
Public Sub Commit

C#
public void Commit()

Exceptions

ExceptionCondition
Ivi.Driver.IviCDriverException The underlying NI-FGEN driver returned an error.

- or -

An underlying driver attribute value was invalid.
ObjectDisposedException Commit was called after the associated NIFgen or FgenDriverUtility object was disposed.

Remarks

This method verifies driver attribute values, reserves the device, and commits the attribute values to the device. If the attribute values are all valid, NI-FGEN sets the device hardware configuration to match the session configuration.
Note: This method does not support the NI 5401/5404/5411/5431 signal generators.

In the committed state, you can load waveforms, scripts, and sequences into memory. If any driver attributes are changed, NI-FGEN implicitly transitions back to the idle state, where you can program all session properties before applying them to the device. This method has no effect if the device is already in the committed or generating state.

Calling this method before the InitiateGeneration method is optional but has the following benefits:

  • Routes are committed, so signals are exported or imported.
  • Any reference clock and external clock circuits are phase-locked.
  • A subsequent call to InitiateGeneration can run faster because the device is already configured.

See Also

Reference

NIFgen Class

NationalInstruments.ModularInstruments.NIFgen Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful