NI FGEN 5404 Routing Function

5404 Routing Function

• niFgen_RouteSignalOut

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_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_ONBOARD_REFERENCE_CLOCK	Onboard Reference Clock

Name	Type	Description
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