NI FGEN Trigger And Syncronizations Functions

Trigger And Syncronizations Functions

• niFgen_ConfigureDigitalEdgeStartTrigger
• niFgen_ConfigureP2PEndpointFullnessStartTrigger
• niFgen_ConfigureSoftwareEdgeStartTrigger
• niFgen_DisableStartTrigger
• niFgen_ConfigureDigitalEdgeScriptTrigger
• niFgen_ConfigureDigitalLevelScriptTrigger
• niFgen_ConfigureSoftwareEdgeScriptTrigger
• niFgen_DisableScriptTrigger
• niFgen_ConfigureTriggerMode
• niFgen_SendSoftwareEdgeTrigger
• niFgen_ConfigureSynchronization
• niFgen_ExportSignal
• niFgen_RouteSignalOut

niFgen_ConfigureDigitalEdgeStartTrigger

ViStatus niFgen_ConfigureDigitalEdgeStartTrigger (ViSession vi, ViConstString source, ViInt32 edge);

Purpose

Configures the Start Trigger for digital edge triggering.

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.
source	ViConstString	Specifies which trigger source the signal generator uses. Defined Values

"PFI0"	PFI 0
"PFI1"	PFI 1
"PFI2"	PFI 2
"PFI3"	PFI 3
"PFI4"	PFI 4
"PFI5"	PFI 5
"PFI6"	PFI 6
"PFI7"	PFI 7
"PXI_Trig0"	PXI trigger line 0 or RTSI line 0
"PXI_Trig1"	PXI trigger line 1 or RTSI line 1
"PXI_Trig2"	PXI trigger line 2 or RTSI line 2
"PXI_Trig3"	PXI trigger line 3 or RTSI line 3
"PXI_Trig4"	PXI trigger line 4 or RTSI line 4
"PXI_Trig5"	PXI trigger line 5 or RTSI line 5
"PXI_Trig6"	PXI trigger line 6 or RTSI line 6
"PXI_Trig7"	PXI trigger line 7 or RTSI line 7
"PXI_Star"	PXI star trigger line

Default Value: "PFI0"

edge	ViInt32	Specifies the edge to detect. Defined Values

NIFGEN_VAL_RISING_EDGE	Occurs when the signal transitions from low level to high level.
NIFGEN_VAL_FALLING_EDGE	Occurs when the signal transitions from high level to low level.

Default Value: NIFGEN_VAL_RISING_EDGE

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

niFgen_ConfigureP2PEndpointFullnessStartTrigger

ViStatus niFgen_ConfigureP2PEndpointFullnessStartTrigger (ViSession vi, ViInt32 p2pEndpointFullnessLevel);

Purpose

Configures the Start Trigger for to detect peer-to-peer endpoint fullness. Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold indicated by the p2pEndpointFullnessLevel parameter.

Note:  Because there is an additional internal FIFO in the signal generator, the writer peer must actually write 2,304 bytes more than the quantity of data specified by this function to satisfy the trigger level.

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.
p2pEndpointFullnessLevel	ViInt32	Specifies the quantity of data in the FIFO endpoint that asserts the trigger. The value –1 specifies that NI-FGEN uses a default value based on your endpoint configuration. Units: samples per channel

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

niFgen_ConfigureSoftwareEdgeStartTrigger

ViStatus niFgen_ConfigureSoftwareEdgeStartTrigger (ViSession vi);

Purpose

Configures the Start Trigger for software edge triggering.

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

niFgen_DisableStartTrigger

ViStatus niFgen_DisableStartTrigger (ViSession vi);

Purpose

Disables the Start Trigger.

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

niFgen_ConfigureDigitalEdgeScriptTrigger

ViStatus niFgen_ConfigureDigitalEdgeScriptTrigger (ViSession vi, ViConstString triggerID, ViConstString source, ViInt32 edge);

Purpose

Configures the specified Script Trigger for digital edge triggering.

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.
triggerID	ViConstString	Specifies the Script Trigger used for triggering. Defined Values

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

Default Value: "ScriptTrigger0"

source	ViConstString	Specifies which trigger source the signal generator uses. Defined Values

"PFI0"	PFI 0
"PFI1"	PFI 1
"PFI2"	PFI 2
"PFI3"	PFI 3
"PFI4"	PFI 4
"PFI5"	PFI 5
"PFI6"	PFI 6
"PFI7"	PFI 7
"PXI_Trig0"	PXI trigger line 0 or RTSI line 0
"PXI_Trig1"	PXI trigger line 1 or RTSI line 1
"PXI_Trig2"	PXI trigger line 2 or RTSI line 2
"PXI_Trig3"	PXI trigger line 3 or RTSI line 3
"PXI_Trig4"	PXI trigger line 4 or RTSI line 4
"PXI_Trig5"	PXI trigger line 5 or RTSI line 5
"PXI_Trig6"	PXI trigger line 6 or RTSI line 6
"PXI_Trig7"	PXI trigger line 7 or RTSI line 7
"PXI_Star"	PXI star trigger line

		Default Value: "PFI0"
edge	ViInt32	Specifies the edge to detect. Defined Values

NIFGEN_VAL_RISING_EDGE	Occurs when the signal transitions from low level to high level.
NIFGEN_VAL_FALLING_EDGE	Occurs when the signal transitions from high level to low level.

Default Value: NIFGEN_VAL_RISING_EDGE

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

niFgen_ConfigureDigitalLevelScriptTrigger

ViStatus niFgen_ConfigureDigitalLevelScriptTrigger (ViSession vi, ViConstString triggerID, ViConstString source, ViInt32 triggerWhen);

Purpose

Configures the specified Script Trigger for digital level triggering.

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.
triggerID	ViConstString	Specifies the Script Trigger used for triggering. Defined Values

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

Default Value: "ScriptTrigger0"

source	ViConstString	Specifies which trigger source the signal generator uses. Defined Values

"PFI0"	PFI 0
"PFI1"	PFI 1
"PFI2"	PFI 2
"PFI3"	PFI 3
"PFI4"	PFI 4
"PFI5"	PFI 5
"PFI6"	PFI 6
"PFI7"	PFI 7
"PXI_Trig0"	PXI trigger line 0 or RTSI line 0
"PXI_Trig1"	PXI trigger line 1 or RTSI line 1
"PXI_Trig2"	PXI trigger line 2 or RTSI line 2
"PXI_Trig3"	PXI trigger line 3 or RTSI line 3
"PXI_Trig4"	PXI trigger line 4 or RTSI line 4
"PXI_Trig5"	PXI trigger line 5 or RTSI line 5
"PXI_Trig6"	PXI trigger line 6 or RTSI line 6
"PXI_Trig7"	PXI trigger line 7 or RTSI line 7
"PXI_Star"	PXI star trigger line

		Default Value: "PFI0"
triggerWhen	ViInt32	Specifies whether the Script Trigger asserts on a high or low digital level. Defined Values

"HighLevel"	Script Trigger asserts on a high digital level.
"LowLevel"	Script Trigger asserts on a low digital level.

Default Value: "HighLevel"

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

niFgen_ConfigureSoftwareEdgeScriptTrigger

ViStatus niFgen_ConfigureSoftwareEdgeScriptTrigger (ViSession vi, ViConstString triggerID);

Purpose

Configures the specified Script Trigger for software edge triggering.

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.
triggerID	ViConstString	Specifies the Script Trigger used for triggering. Defined Values

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

Default Value: "ScriptTrigger0"

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

niFgen_DisableScriptTrigger

ViStatus niFgen_DisableScriptTrigger (ViSession vi, ViConstString triggerID);

Purpose

Disables the specified Script Trigger.

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.
triggerID	ViConstString	Specifies the Script Trigger used for triggering. Defined Values

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

Default Value: "ScriptTrigger0"

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

niFgen_ConfigureTriggerMode

ViStatus niFgen_ConfigureTriggerMode (ViSession vi, ViConstString channelName, ViInt32 triggerMode);

Purpose

Sets the trigger mode for your device. Refer to the Trigger Modes topic for your device in the NI Signal Generators Help for descriptions of the specific behavior for supported trigger modes.

Note:  The signal generator must not be in the Generating state when you call this function.

In Frequency List output mode, Stepped trigger mode is the same as Burst trigger mode.

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 the trigger mode. Default Value: "0"
triggerMode	ViInt32	Specifies the trigger mode. Defined Values

NIFGEN_VAL_SINGLE	The waveform that you describe in the sequence list generates only once by going through the entire staging list. Only one trigger is required to start the waveform generation. You can use Single trigger mode in any output mode. After a trigger is received, the waveform generation starts from the first stage and continues through to the last stage.
NIFGEN_VAL_CONTINUOUS	The waveform that you describe in the staging list generates infinitely by repeatedly cycling through the staging list. After a trigger is received, the waveform generation starts from the first stage and continues through to the last stage. After the last stage is completed, the waveform generation loops back to the start of the first stage and continues until it is stopped. Only one trigger is required to start the waveform generation.
NIFGEN_VAL_STEPPED	After a Start Trigger is received, the waveform described by the first stage generates. Then, the device waits for the next trigger signal. On the next trigger, the waveform described by the second stage generates, and so on. After the staging list is exhausted, the waveform generation returns to the first stage and continues to repeat the cycle.
NIFGEN_VAL_BURST	After a Start Trigger is received, the waveform described by the first stage generates until another trigger is received. At the next trigger, the buffer of the previous stage completes, then the waveform described by the second stage generates. After the staging list is exhausted, the waveform generation returns to the first stage and continues to repeat the cycle. In Frequency List mode, the duration instruction is ignored, and the trigger switches the frequency to the next frequency in the list.

Default Value: NIFGEN_VAL_CONTINUOUS

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

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

		Default Value: NIFGEN_VAL_START_TRIGGER
triggerID	ViConstString	Identifies the specific trigger to use. Defined Values

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

Default Value: "None"

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

niFgen_ConfigureSynchronization

ViStatus niFgen_ConfigureSynchronization (ViSession vi, ViConstString channelName, ViInt32 synchronizationSource);

Purpose

Sets the signal generator to receive a synchronization signal to synchronize two or more NI 5401/5411/5431 signal generators. One signal generator should route a SYNC signal to a RTSI line by calling the niFgen_ExportSignal function (use the niFgen_RouteSignalOut function for the NI 5404), and other signal generators should receive the signal by calling the niFgen_ConfigureSynchronization function.

Note:  The signal generator must not be in the Generating state when you call this function.

Only the NI 5401/5411/5431 signal generators require this function to be called for proper synchronization.

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 the synchronization signal. Default Value: "0"
synchronizationSource	ViInt32	Specify the source of the synchronization signal you want to use. Defined Values

NIFGEN_VAL_NONE	Specifies that no synchronization source is used.
NIFGEN_VAL_RTSI_0	Specifies that RTSI 0 or PXI_Trig 0 is used as the synchronization source.
NIFGEN_VAL_RTSI_1	Specifies that RTSI 1 or PXI_Trig 1 is used as the synchronization source.
NIFGEN_VAL_RTSI_2	Specifies that RTSI 2 or PXI_Trig 2 is used as the synchronization source.
NIFGEN_VAL_RTSI_3	Specifies that RTSI 3 or PXI_Trig 3 is used as the synchronization source.
NIFGEN_VAL_RTSI_4	Specifies that RTSI 4 or PXI_Trig 4 is used as the synchronization source.
NIFGEN_VAL_RTSI_5	Specifies that RTSI 5 or PXI_Trig 5 is used as the synchronization source.
NIFGEN_VAL_RTSI_6	Specifies that RTSI 6 or PXI_Trig 6 is used as the synchronization source.
NIFGEN_VAL_TTL0	Specifies that TTL 0 is used as the synchronization source.
NIFGEN_VAL_TTL1	Specifies that TTL 1 is used as the synchronization source.
NIFGEN_VAL_TTL2	Specifies that TTL 2 is used as the synchronization source.
NIFGEN_VAL_TTL3	Specifies that TTL 3 is used as the synchronization source.
NIFGEN_VAL_TTL4	Specifies that TTL 4 is used as the synchronization source.
NIFGEN_VAL_TTL5	Specifies that TTL 5 is used as the synchronization source.
NIFGEN_VAL_TTL6	Specifies that TTL 6 is used as the synchronization source.

		Default Value: NIFGEN_VAL_NONE

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

niFgen_ExportSignal

ViStatus niFgen_ExportSignal (ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal);

Purpose

Routes signals (clocks, triggers, and events) to the output terminal you specify.

Any routes created within a session persist after the session closes to prevent signal glitching. To unconfigure signal routes created in previous sessions, set resetDevice in the niFgen_init function to VI_TRUE or use the niFgen_ResetDevice function.

If you export a signal with this function and commit the session, the signal is routed to the output terminal you specify.

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.
signal	ViInt32	Specifies the source of the signal to route. Defined Values

NIFGEN_VAL_ONBOARD_REFERENCE_CLOCK	Onboard 10 MHz synchronization clock (PCI only)
NIFGEN_VAL_SYNC_OUT	SYNC OUT signal The SYNC OUT signal is normally generated on the SYNC OUT front panel connector.
NIFGEN_VAL_START_TRIGGER	Start Trigger
NIFGEN_VAL_MARKER_EVENT	Marker Event
NIFGEN_VAL_SAMPLE_CLOCK_TIMEBASE	The clock from which the Sample Clock is derived
NIFGEN_VAL_SYNCHRONIZATION	Synchronization strobe (NI 5404/5411/5431 only) A synchronization strobe is used to guarantee absolute synchronization between two or more signal generators.
NIFGEN_VAL_SAMPLE_CLOCK	Sample Clock
NIFGEN_VAL_REFERENCE_CLOCK	PLL Reference Clock
NIFGEN_VAL_SCRIPT_TRIGGER	Script Trigger
NIFGEN_VAL_READY_FOR_START_EVENT	Ready For Start Event
NIFGEN_VAL_STARTED_EVENT	Started Event
NIFGEN_VAL_DONE_EVENT	Done Event
NIFGEN_VAL_DATA_MARKER_EVENT	Data Marker Event

signalIdentifier	ViConstString	Specifies which instance of the selected signal to export
Defined Values

"" (empty string)	Default (for non instance-based signals)
"ScriptTrigger0"	Script Trigger 0
"ScriptTrigger1"	Script Trigger 1
"ScriptTrigger2"	Script Trigger 2
"ScriptTrigger3"	Script Trigger 3
"Marker0"	Marker 0
"Marker1"	Marker 1
"Marker2"	Marker 2
"Marker3"	Marker 3
"DataMarker0"	Data Marker 0*
"DataMarker1"	Data Marker 1*
"DataMarker2"	Data Marker 2*
"DataMarker3"	Data Marker 3*
* These Data Marker values apply only to single-channel devices or to multichannel devices that are configured for single-channel operation. When using a device that is configured for multichannel operation, specify the channel number along with the signal identifier. For example, to export Data Marker 0 on channel 1 of a device configured for multichannel operation, use the value "1/ DataMarker0." If you do not specify a channel when using a device configured for multichannel generation, DataMarker0 generates on all channels.

outputTerminal	ViConstString	Specifies the output terminal to export the signal.

Note:   The following Defined Values are examples of possible output terminals. For a complete list of the output terminals available on your device, refer to the Routes topic for your device or the Device Routes tab in MAX.

Defined Values

"" (empty string)	Do not export signal
"PFI0"	PFI line 0
"PFI1"	PFI line 1
"PFI4"	PFI line 4
"PFI5"	PFI line 5
"PXI_Trig0"	PXI or RTSI line 0
"PXI_Trig1"	PXI or RTSI line 1
"PXI_Trig2"	PXI or RTSI line 2
"PXI_Trig3"	PXI or RTSI line 3
"PXI_Trig4"	PXI or RTSI line 4
"PXI_Trig5"	PXI or RTSI line 5
"PXI_Trig6"	PXI or RTSI line 6
"PXI_Trig7"	PXI or RTSI line 7
"DDC_ClkOut"	Clock out from DDC connector
"PXI_Star"	PXI star trigger line

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

niFgen_RouteSignalOut

ViStatus niFgen_RouteSignalOut (ViSession vi, ViConstString channelName, ViInt32 routeSignalFrom, ViInt32 routeSignalTo);

Purpose

Routes various signals in the signal generator to the RTSI lines and front panel terminals.

Note:  The signal generator must not be in the Generating state when you call this function.

You can clear a previously routed signal by routing NIFGEN_VAL_NONE to the destination terminal.

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 route a signal. Default Value: "0"
routeSignalFrom	ViInt32	Various signals can be routed out the RTSI lines. Defined Values

NIFGEN_VAL_NONE	Nothing Sending this value clears the line.
NIFGEN_VAL_MARKER	Marker Event
NIFGEN_VAL_SYNC_OUT	SYNC signal This signal normally appears on the SYNC OUT front panel connector.
NIFGEN_VAL_OUT_START_TRIGGER	Start Trigger The Start Trigger is normally generated at the start of the sequence. Call the niFgen_ConfigureTriggerSource function to receive this trigger.
NIFGEN_VAL_BOARD_CLOCK	Signal generator board clock The signal generator board clock is 20 MHz for the NI PCI-5401/5411/5431. The NI PXI-5404 has a 20 MHz board clock, and the NI PXI-5421 has integer divisors of 100 MHz. The NI PXI-5401/5411/5431 does not support routing a Board Clock to RTSI lines or front panel connectors.
NIFGEN_VAL_SYNCHRONIZATION	Synchronization strobe A synchronization strobe is used to guarantee absolute synchronization between two or more signal generators. Call the niFgen_ConfigureSynchronization function to receive the strobe.
NIFGEN_VAL_SOFTWARE_TRIG	Software trigger
NIFGEN_VAL_OUT_UPDATE	—
NIFGEN_VAL_REF_OUT	Reference Clock out front panel connector
NIFGEN_VAL_PXI_CLK10	PXI 10 MHz backplane Reference Clock
NIFGEN_VAL_PXI_STAR	PXI star trigger line
NIFGEN_VAL_PFI_0	PFI 0
NIFGEN_VAL_RTSI_0	RTSI 0 or PXI_Trig 0
NIFGEN_VAL_RTSI_1	RTSI 1 or PXI_Trig 1
NIFGEN_VAL_RTSI_2	RTSI 2 or PXI_Trig 2
NIFGEN_VAL_RTSI_3	RTSI 3 or PXI_Trig 3
NIFGEN_VAL_RTSI_4	RTSI 4 or PXI_Trig 4
NIFGEN_VAL_RTSI_5	RTSI 5 or PXI_Trig 5
NIFGEN_VAL_RTSI_6	RTSI 6 or PXI_Trig 6
NIFGEN_VAL_RTSI_7	RTSI 7 or PXI_Trig 7
NIFGEN_VAL_REF_CLOCK_RTSI_CLOCK	RTSI clock
NIFGEN_VAL_ONBOARD_REFERENCE_CLOCK	Onboard Reference Clock
NIFGEN_VAL_UPDATE_CLOCK	Sample Clock
NIFGEN_VAL_PLL_REF_SOURCE	PLL Reference Clock

routeSignalTo	ViInt32	The possible RTSI lines to which you can route a signal. Defined Values

NIFGEN_VAL_RTSI_0	RTSI 0 or PXI_Trig 0
NIFGEN_VAL_RTSI_1	RTSI 1 or PXI_Trig 1
NIFGEN_VAL_RTSI_2	RTSI 2 or PXI_Trig 2
NIFGEN_VAL_RTSI_3	RTSI 3 or PXI_Trig 3
NIFGEN_VAL_RTSI_4	RTSI 4 or PXI_Trig 4
NIFGEN_VAL_RTSI_5	RTSI 5 or PXI_Trig 5
NIFGEN_VAL_RTSI_6	RTSI 6 or PXI_Trig 6
NIFGEN_VAL_RTSI_7	RTSI 7 or PXI_Trig 7
NIFGEN_VAL_REF_CLOCK_RTSI_CLOCK	RTSI clock
NIFGEN_VAL_REF_OUT	Reference Clock out front panel connector
NIFGEN_VAL_PFI_0	PFI 0
NIFGEN_VAL_PFI_1	PFI 1
NIFGEN_VAL_PFI_4	PFI 4
NIFGEN_VAL_PFI_5	PFI 5
NIFGEN_VAL_PXI_STAR	PXI star trigger line
NIFGEN_VAL_PXI_CLK10	PXI 10 MHz backplane Reference Clock

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