rfsa c api reference

niRFSA_ExportSignal

  • Updated2024-05-08
  • 3 minute(s) read

niRFSA_ExportSignal

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

Purpose

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

If you export a signal with this function and commit the session, the signal is routed to the output terminal you specify. If you then reconfigure the signal to have a different output terminal, the previous output terminal is tri-stated when the session is next committed. If you set the outputTerminal parameter to NIRFSA_VAL_DO_NOT_EXPORT and commit, the previous output terminal is tristated.

Any signals, except for those exported over PXI trigger lines, that are exported within a session persist after the session closes to prevent signal glitches between sessions. PXI trigger lines are always set to tristate when a session is closed. If you wish to have the output terminal tristated when the session closes, change the outputTerminal for the exported signal to NIRFSA_VAL_DO_NOT_EXPORT, and commit the session again before closing it.

You can also tristate all PFI lines by setting the resetDevice parameter in the niRFSA_init function to VI_TRUE or by using the niRFSA_reset function.

Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
signal ViInt32 Specifies the type of signal to route.

NIRFSA_VAL_START_TRIGGER (1100)NI-RFSA routes a Start Trigger.
NIRFSA_VAL_REF_TRIGGER (702)NI-RFSA routes a Reference trigger.
NIRFSA_VAL_ADVANCE_TRIGGER (1102)NI-RFSA routes an Advance Trigger.
NIRFSA_VAL_READY_FOR_START_EVENT (1200)NI-RFSA routes a Ready for Start Event.
NIRFSA_VAL_READY_FOR_ADVANCE_EVENT (1202)NI-RFSA routes a Ready for Advance Event.
NIRFSA_VAL_READY_FOR_REF_EVENT (1201)NI-RFSA routes a Ready for Reference Event.
NIRFSA_VAL_END_OF_RECORD_EVENT (1203)NI-RFSA routes an End of Record Event.
NIRFSA_VAL_DONE_EVENT (1204)NI-RFSA routes a Done Event.
NIRFSA_VAL_REF_CLOCK (1205)NI-RFSA routes a Reference Clock signal.
NIRFSA_VAL_USER (1206)NI-RFSA routes a user-defined signal, specified using the signalIdentifier parameter.
signalIdentifier ViConstString Specifies the user-defined signal to route. Specify the signal you have implemented using FPGA extensions.
outputTerminal ViConstString Specifies the terminal where the signal will be exported. You can also choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841.

NIRFSA_VAL_DO_NOT_EXPORT_STR The signal is not exported.
NIRFSA_VAL_CLK_OUT_STR The signal is exported to the CLK OUT connector on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841/5842.
NIRFSA_VAL_REF_OUT_STR The signal is exported to the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5694, PXIe-5644/5645/5646, or PXIe-5820/5830/5831/5832/5840/5841/5842.
NIRFSA_REF_OUT2_STR The signal is exported to the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.
NIRFSA_VAL_PFI0_STR The signal is exported to the PFI 0 connector.
NIRFSA_VAL_PFI1_STR The signal is exported to the PFI 1 connector on the PXI-5142 and PXIe-5622.
NIRFSA_VAL_PXI_TRIG0_STR The signal is exported to the PXI trigger line 0.
NIRFSA_VAL_PXI_TRIG1_STR The signal is exported to the PXI trigger line 1.
NIRFSA_VAL_PXI_TRIG2_STR The signal is exported to the PXI trigger line 2.
NIRFSA_VAL_PXI_TRIG3_STR The signal is exported to the PXI trigger line 3.
NIRFSA_VAL_PXI_TRIG4_STR The signal is exported to the PXI trigger line 4.
NIRFSA_VAL_PXI_TRIG5_STR The signal is exported to the PXI trigger line 5.
NIRFSA_VAL_PXI_TRIG6_STR The signal is exported to the PXI trigger line 6.
NIRFSA_VAL_PXI_TRIG7_STR The signal is exported to the PXI trigger line 7.
NIRFSA_VAL_PXI_STAR_STR The signal is exported to the PXI star trigger line.
NIRFSA_VAL_PXIE_DSTARC_STR The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842.
NIRFSA_VAL_DIO0_STR ("PFI0") The trigger is received on PFI 0 of the DIO Terminal.
NIRFSA_VAL_DIO1_STR ("PFI0") The trigger is received on PFI 1 of the DIO Terminal.
NIRFSA_VAL_DIO2_STR ("PFI0") The trigger is received on PFI 2 of the DIO Terminal.
NIRFSA_VAL_DIO3_STR ("PFI0") The trigger is received on PFI 3 of the DIO Terminal.
NIRFSA_VAL_DIO4_STR ("PFI0") The trigger is received on PFI 4 of the DIO Terminal.
NIRFSA_VAL_DIO5_STR ("PFI0") The trigger is received on PFI 5 of the DIO Terminal.
NIRFSA_VAL_DIO6_STR ("PFI0") The trigger is received on PFI 6 of the DIO Terminal.
NIRFSA_VAL_DIO7_STR ("PFI0") The trigger is received on PFI 7 of the DIO Terminal.

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. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience