NI FGEN Standard Function Attributes - ni/grpc-device GitHub Wiki

Standard Function Attributes

NIFGEN_ATTRIBUTE_FUNC_WAVEFORM

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250101 ViInt32 R/W Channel None niFgen_ConfigureStandardWaveform
  • [niFgen_DefineUserStandardWaveform]|

Description

Specifies which standard waveform the signal generator produces.

Use this attribute only when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_FUNC.

Defined Values

NIFGEN_VAL_WFM_SINE Sinusoid waveform
NIFGEN_VAL_WFM_SQUARE Square waveform
NIFGEN_VAL_WFM_TRIANGLE Triangle waveform
NIFGEN_VAL_WFM_RAMP_UP Positive ramp waveform
NIFGEN_VAL_WFM_RAMP_DOWN Negative ramp waveform
NIFGEN_VAL_WFM_DC Constant voltage
NIFGEN_VAL_WFM_NOISE White noise
NIFGEN_VAL_WFM_USER User-defined waveform as defined with the niFgen_DefineUserStandardWaveform function

Default Value: NIFGEN_VAL_WFM_SINE

NIFGEN_ATTRIBUTE_FUNC_AMPLITUDE

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250102 ViReal64 R/W Channel None niFgen_ConfigureStandardWaveform

Description

Controls the amplitude of the standard waveform that the signal generator produces. This value is the amplitude at the output terminal.

For example, to produce a waveform ranging from –5.00 V to +5.00 V, set this attribute 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: Vpk-pk

Default Value: None

NIFGEN_ATTRIBUTE_FUNC_DC_OFFSET

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250103 ViReal64 R/W Channel None niFgen_ConfigureStandardWaveform

Description

Controls the DC offset of the standard waveform that the signal generator produces. This value is the offset at the output terminal. The value is the offset from ground to the center of the waveform that you specify with the waveform parameter of the niFgen_ConfigureStandardWaveform function.

For example, to configure a waveform with an amplitude of 10.00 V to range from 0.00 V to +10.00 V, set this attribute to 5.00 V.

Units: volts

Default Value: None

NIFGEN_ATTRIBUTE_FUNC_START_PHASE

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250105 ViReal64 R/W Channel None niFgen_ConfigureStandardWaveform

Description

Controls horizontal offset of the standard waveform the signal generator produces. Specify this attribute in degrees of one waveform cycle.

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 of the niFgen_ConfigureStandardWaveform function to NIFGEN_VAL_WFM_DC.

Units: Degrees of one cycle

Default Value: None

NIFGEN_ATTRIBUTE_FUNC_DUTY_CYCLE_HIGH

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250106 ViReal64 R/W Channel None None

Description

Controls the duty cycle of the square wave the signal generator produces. Specify this attribute as a percentage of the time the square wave is high in a cycle.

Note:   This parameter only affects signal generator behavior when you set the waveform parameter of the niFgen_ConfigureStandardWaveform function to NIFGEN_VAL_WFM_SQUARE.

Units: Percentage of time the waveform is high

Default Value: 50%

NIFGEN_ATTRIBUTE_SYNC_DUTY_CYCLE_HIGH

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150105 ViReal64 R/W N/A None None

Description

Controls the duty cycle of the square wave the signal generator produces on the SYNC OUT connector. Specify this attribute as a percentage of the time the square wave is high in each cycle.

Units: Percentage of the time the waveform is high

Default Value: 50%

NIFGEN_ATTRIBUTE_SYNC_OUT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150330 ViString R/W N/A None None

Description

Specifies the terminal to export the SYNC OUT signal. For a list of the terminals available on your device, refer to the Routes topic for your device or the the Device Routes tab in MAX. This attribute is not supported for all devices.

NIFGEN_ATTRIBUTE_FUNC_FREQUENCY

IviFgenStdFunc Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250104 ViReal64 R/W Channel None niFgen_ConfigureStandardWaveform

Description

Controls the frequency of the standard waveform that the signal generator produces.

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.

For NIFGEN_VAL_WFM_SINE, the range is between 0 MHz and 16 MHz, but the range is between 0 MHz and 1 MHz for all other waveforms. Units: hertz (Hz)

Default Value: None

NIFGEN_ATTRIBUTE_FUNC_MAX_BUFFER_SIZE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150239 ViInt32 R/W N/A None None

Description

Specifies the maximum number of samples that can be used in the standard function waveform buffer. Increasing this value may increase the quality of the waveform. This attribute is valid only on devices that implement Standard Function output mode in software, and it is read-only for all other devices.

Note:  Refer to the Standard Function Mode topic in the NI Signal Generators Help for more information about the implementation of Standard Function output mode on your device.

NIFGEN_ATTRIBUTE_FUNC_BUFFER_SIZE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150238 ViInt32 R/W N/A None None

Description

Contains the number of samples used in the standard function waveform buffer. This attribute is valid only on devices that implement Standard Function output mode in software, and it is read-only for all other devices.

Note:  Refer to the Standard Function Mode topic for more information about the implementation of Standard Function output mode on your device.

NIFGEN_ATTRIBUTE_FREQ_LIST_HANDLE

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150208 ViInt32 R/W N/A None None

Description

Sets which frequency list the signal generator produces. Create a frequency list using the niFgen_CreateFreqList function. The niFgen_CreateFreqList function returns a handle that you can use to identify the list.

Note:  You cannot change this attribute while the device is generating a waveform. If you want to change the device configuration, call the niFgen_AbortGeneration function or wait for the generation to complete.

NIFGEN_ATTRIBUTE_MAX_NUM_FREQ_LISTS

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150209 ViInt32 RO N/A None None

Description

Returns the maximum number of frequency lists the signal generator allows.

NIFGEN_ATTRIBUTE_MAX_FREQ_LIST_LENGTH

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150211 ViInt32 RO N/A None None

Description

Returns the maximum number of steps that can be in a frequency list.

NIFGEN_ATTRIBUTE_MIN_FREQ_LIST_LENGTH

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150210 ViInt32 RO N/A None None

Description

Returns the minimum number of frequency lists that the signal generator allows.

NIFGEN_ATTRIBUTE_FREQ_LIST_DURATION_QUANTUM

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150214 ViReal64 R/W N/A None None

Description

Returns the quantum of which all durations must be a multiple in a frequency list.

NIFGEN_ATTRIBUTE_MAX_FREQ_LIST_DURATION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150213 ViReal64 RO N/A None None

Description

Specifies the maximum duration of any one step in the frequency list.

Note:  You cannot change this attribute while the device is generating a waveform. If you want to change the device configuration, call the niFgen_AbortGeneration function or wait for the generation to complete.

NIFGEN_ATTRIBUTE_MIN_FREQ_LIST_DURATION

Specific Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1150212 ViReal64 RO N/A None None

Description

Returns the minimum duration in seconds of any one step in a frequency list.

⚠️ **GitHub.com Fallback** ⚠️