Configure Method

NI Signal Generators Help (NI-FGEN 18.1)

Edition Date: April 2018

Part Number: 370524V-01

»View Product Info
Download Help (Windows Only)

FgenStandardWaveform Class See Also


Configures the properties of the signal generator that affect standard waveform generation.

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 Configure ( _
	channelName As String, _
	waveformFunction As StandardWaveform, _
	amplitude As Double, _
	dcOffset As Double, _
	frequency As Double, _
	startPhase As Double _
)

C#
public void Configure(
	string channelName,
	StandardWaveform waveformFunction,
	double amplitude,
	double dcOffset,
	double frequency,
	double startPhase
)

Parameters

channelName
Type: System..::.String
The channel to be used.
waveformFunction
Type: NationalInstruments.ModularInstruments.NIFgen..::.StandardWaveform
The standard waveform that you want the signal generator to produce.
amplitude
Type: System..::.Double
The peak-to-peak amplitude of the standard waveform that you want the signal generator to produce.
dcOffset
Type: System..::.Double
The DC offset of the standard waveform that you want the signal generator to produce.
frequency
Type: System..::.Double
The frequency of the standard waveform that you want the signal generator to produce.
startPhase
Type: System..::.Double
The horizontal offset, in degrees of one waveform cycle, of the standard waveform that you want the signal generator to produce.

Exceptions

ExceptionCondition
Ivi.Driver.IviCDriverException The underlying NI-FGEN driver returned an error.
Ivi.Driver.SelectorNameException The value for channelName is invalid.

- or -

The value for channelName is unknown.
ArgumentException The value for waveformFunction is invalid.

- or -

The value for amplitude is invalid.

- or -

The value for dcOffset is invalid.

- or -

The value for frequency is invalid.

- or -

The value for startPhase is invalid.
InvalidOperationException FgenOutput.OutputMode is not set to OutputMode.Function.
InvalidOperationException FgenOutput.OutputMode is not set to OutputMode.Function.
ObjectDisposedException FgenStandardWaveform.Configure was called after the associated NIFgen or FgenDriverUtility object was disposed.

Remarks

When specifying the startPhase, a start phase of 180 degrees means output generation begins halfway through the waveform cycle. A start phase of 360 degrees offsets the output by an entire waveform cycle and is therefore identical to a start phase of 0 degrees.

The value of dcOffset is the offset at the output terminal. The value is the offset from ground to the center of the waveform that you specify with waveformFunction. For example, to configure a waveform with a peak-to-peak amplitude of 10.00 V to range from 0.00 V to +10.00 V, set dcOffset to 5.00 V.

See Also

Reference

FgenStandardWaveform Class

NationalInstruments.ModularInstruments.NIFgen Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful