NI FGEN Waveform Control Functions - ni/grpc-device GitHub Wiki

Waveform Control Functions

niFgen_SendSoftwareEdgeTrigger

ViStatus niFgen_SendSoftwareEdgeTrigger (ViSession vi, viInt32 trigger, viConstString triggerID);

Purpose

Sends a command to trigger the signal generator. This VI can act as an override for an external edge trigger.

Note:  This VI does not override external digital edge triggers of the NI 5401/5411/5431.

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.
trigger ViInt32

Specifies the type of trigger to send.

Default Value: NIFGEN_VAL_START_TRIGGER

Defined Values

NIFGEN_VAL_START_TRIGGER Transitions the device from an Idle state to a Generation state where the device can respond to Sample clocks.
NIFGEN_VAL_SCRIPT_TRIGGER Allows you to create sophisticated generation operations that are determined by the generation script.
triggerID ViConstString

Identifies the specific trigger to use.

Default Value: "None"

Defined Values

"None" None
"ScriptTrigger0" Script Trigger 0
"ScriptTrigger1" Script Trigger 1
"ScriptTrigger2" Script Trigger 2
"ScriptTrigger3" Script Trigger 3

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 theniFgen_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

niFgen_InitiateGeneration

ViStatus niFgen_InitiateGeneration (ViSession vi);

Purpose

Initiates signal generation. If you want to abort signal generation, call the niFgen_AbortGeneration function. After the signal generation is aborted, you can call the niFgen_InitiateGeneration function to cause the signal generator to produce a signal again.

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.

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 theniFgen_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

niFgen_AbortGeneration

ViStatus niFgen_AbortGeneration (ViSession vi);

Purpose

Aborts any previously initiated signal generation. Call the niFgen_InitiateGeneration function to cause the signal generator to produce a signal again.

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.

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 theniFgen_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
⚠️ **GitHub.com Fallback** ⚠️