niFgen_ConfigureStandardWaveform

NI Signal Generators Help (NI-FGEN 18.1)

Edition Date: April 2018

Part Number: 370524V-01

»View Product Info
Download Help (Windows Only)

ViStatus niFgen_ConfigureStandardWaveform (ViSession vi, ViConstString channelName, ViInt32 waveform, ViReal64 amplitude, ViReal64 dcOffset, ViReal64 frequency, ViReal64 startPhase);

Purpose

Configures the following attributes of the signal generator that affect standard waveform generation:

  • NIFGEN_ATTR_FUNC_WAVEFORM
  • NIFGEN_ATTR_FUNC_AMPLITUDE
  • NIFGEN_ATTR_FUNC_DC_OFFSET
  • NIFGEN_ATTR_FUNC_FREQUENCY
  • NIFGEN_ATTR_FUNC_START_PHASE
Note  You must call the niFgen_ConfigureOutputMode function with the outputMode parameter set to NIFGEN_VAL_OUTPUT_FUNC before calling this function.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session.
channelName ViConstString Specifies the channel name for which you want to configure a standard waveform.

Default Value: "0"

waveform ViInt32 Specifies the standard waveform that you want the signal generator to produce. NI-FGEN sets the NIFGEN_ATTR_FUNC_WAVEFORM attribute to this value.

Defined Values

NIFGEN_VAL_WFM_SINE Specifies that the signal generator produces a sinusoid waveform.
NIFGEN_VAL_WFM_SQUARE Specifies that the signal generator produces a square waveform.
NIFGEN_VAL_WFM_TRIANGLE Specifies that the signal generator produces a triangle waveform.
NIFGEN_VAL_WFM_RAMP_UP Specifies that the signal generator produces a positive ramp waveform.
NIFGEN_VAL_WFM_RAMP_DOWN Specifies that the signal generator produces a negative ramp waveform.
NIFGEN_VAL_WFM_DC Specifies that the signal generator produces a constant voltage.
NIFGEN_VAL_WFM_NOISE Specifies that the signal generator produces white noise.
NIFGEN_VAL_WFM_USER Specifies that the signal generator produces a user-defined waveform as defined with the niFgen_DefineUserStandardWaveform function.

Default Value: NIFGEN_VAL_WFM_SINE

amplitude ViReal64 Specifies the amplitude of the standard waveform that you want the signal generator to produce. This value is the amplitude at the output terminal. NI-FGEN sets the NIFGEN_ATTR_FUNC_AMPLITUDE attribute to this value.

For example, to produce a waveform ranging from –5.00 V to +5.00 V, set the amplitude to 10.00 V.

Note   This parameter does not affect signal generator behavior when you set the waveform parameter of the niFgen_ConfigureStandardWaveform function to NIFGEN_VAL_WFM_DC.

Units: peak-to-peak voltage

Default Value: None

dcOffset ViReal64 Specifies the DC offset of the standard waveform that you want the signal generator to produce. The value is the offset from ground to the center of the waveform you specify with the waveform parameter, observed at the output terminal. For example, to configure a waveform with an amplitude of 10.00 V to range from 0.00 V to +10.00 V, set the dcOffset to 5.00 V. NI-FGEN sets the NIFGEN_ATTR_FUNC_DC_OFFSET attribute to this value.

Units: volts

Default Value: None

frequency ViReal64 Specifies the frequency of the standard waveform that you want the signal generator to produce. NI-FGEN sets the NIFGEN_ATTR_FUNC_FREQUENCY attribute to this value.

Notes  This parameter does not affect signal generator behavior when you set the waveform parameter of the niFgen_ConfigureStandardWaveform function to NIFGEN_VAL_WFM_DC.
Frequency ranges vary from device to device. For information about the frequencies supported on your device, refer to the Features Supported topic for your device in the NI Signal Generators Help.

Units: hertz

Default Value: None

startPhase ViReal64 Specifies the horizontal offset of the standard waveform that you want the signal generator to produce. Specify this parameter in degrees of one waveform cycle. NI-FGEN sets the NIFGEN_ATTR_FUNC_START_PHASE attribute to this value. A start phase of 180 degrees means output generation begins halfway through the waveform. A start phase of 360 degrees offsets the output by an entire waveform cycle, which is identical to a start phase of 0 degrees.
Note   This parameter does not affect signal generator behavior when you set the waveform parameter to NIFGEN_VAL_WFM_DC.

Units: degrees of one cycle

Default Value: 0.00

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred. To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful