ni-rfsg-c-api-ref-doc

niRFSG_ConfigureGenerationMode

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

niRFSG_ConfigureGenerationMode

C Function Prototype

ViStatus niRFSG_ConfigureGenerationMode (ViSession vi, ViInt32 generationMode);

Purpose

Configures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842

Related Topics

Assigning Properties or Attributes to a Waveform

Scripting Instructions—Refer to this topic for more information about VST restrictions on scripts.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
generationMode ViInt32 Specifies the mode used by NI-RFSG for generating an RF output signal.

Defined Values:

NIRFSG_VAL_CWConfigures the RF signal generator to generate a CW signal.
NIRFSG_VAL_ARB_WAVEFORMConfigures the RF signal generator to generate arbitrary waveforms.
NIRFSG_VAL_SCRIPTConfigures the RF signal generator to generate arbitrary waveforms as directed by scripts.

Default Value: NIRFSG_VAL_CW



 Note  For the PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, only NIRFSG_VAL_CW is supported.


 Note  If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported.

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 instrument driver function to determine if an error occurred.

To obtain a text description of the error code, call the niRFSG_GetError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors

Log in to get a better experience