NI RFSG Generation Configuration

Generation Configuration

Configure Waveform
Configure List
Configure Trigger
Configure Clock
De Embedding
Peer To Peer (P2P)
- niRFSG_GetStreamEndpointHandle
- niRFSG_WriteP2PEndpointI16
Scripting
- niRFSG_CheckIfScriptExists
- niRFSG_WriteScript
niRFSG_ConfigureOutputEnabled
niRFSG_ConfigureIQEnabled
Set/Get/Check Attribute

Configure Waveform

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

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_CW|Configures the RF signal generator to generate a CW signal.| |NIRFSG_VAL_ARB_WAVEFORM|Configures the RF signal generator to generate arbitrary waveforms.| |NIRFSG_VAL_SCRIPT|Configures 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

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:

|

niRFSG_WriteArbWaveform

C Function Prototype

ViStatus niRFSG_WriteArbWaveform (ViSession vi, ViConstString waveformName, ViInt32 numberOfSamples, ViReal64[] iData, ViReal64[] qData, ViBoolean moreDataPending);

Purpose

Writes an arbitrary waveform to the NI-RFSG device. This function configures the I and Q vectors of a complex baseband signal. If the waveform to write is already allocated using the niRFSG_AllocateArbWaveform function, the moreDataPending parameter is ignored. The PXI-5670/5671 must be in the Configuration state before you call this function. When streaming is enabled, you can call this function when the PXIe-5672/5673/5673E and PXIe-5820/5830/5831/5832/5840/5841 is in the Generation state.

| Note |Note On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841, the moreDataPending parameter is always ignored. To write data in blocks on these devices, you must allocate the waveform before writing it.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |numberOfSamples|ViInt32|Specifies the number of samples in both the iData and qData arrays. The iData and qData arrays must have the same length. If the NIRFSG_ATTR_ARB_WAVEFORM_QUANTUM attribute value is q, then the number of samples should be a multiple of q. The specified number of samples cannot be 0.| |iData|ViReal64[]|Specifies the in-phase (I) component of the complex baseband signal.| |qData|ViReal64[]|Specifies the quadrature (Q) component of the complex baseband signal.| |moreDataPending|ViBoolean|Specifies whether or not the data block contains the end of the waveform. Set this parameter to VI_TRUE to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set moreDataPending to VI_FALSE to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.|

Return Value

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:

|

niRFSG_WriteArbWaveformF32

C Function Prototype

ViStatus niRFSG_WriteArbWaveformF32 (ViSession vi, ViConstString waveformName, ViInt32 numberOfSamples, ViReal32[] iData, ViReal32[] qData, ViBoolean moreDataPending);

Purpose

Writes an arbitrary waveform to the NI-RFSG device. This function configures the I and Q vectors of a complex single baseband signal. If the waveform to write is already allocated using the niRFSG_AllocateArbWaveform function, the moreDataPending parameter is ignored. The PXI-5670/5671 must be in the Configuration state before you call this function. When streaming is enabled, you can call this function when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840/5841 is in the Generation state.

| Note |Note On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841, the moreDataPending parameter is always ignored. To write data in blocks on these devices, you must allocate the waveform before writing it.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |numberOfSamples|ViInt32|Specifies the number of samples in both the iData and qData arrays. The iData and qData arrays must have the same length. If the NIRFSG_ATTR_ARB_WAVEFORM_QUANTUM attribute value is q, then the number of samples should be a multiple of q. The specified number of samples cannot be 0.| |iData|ViReal32[]|Specifies the in-phase (I) component of the complex baseband signal.| |qData|ViReal32[]|Specifies the quadrature (Q) component of the complex baseband signal.| |moreDataPending|ViBoolean|Specifies whether or not the data block contains the end of the waveform. Set this parameter to VI_TRUE to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set moreDataPending to VI_FALSE to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.|

Return Value

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:

|

niRFSG_WriteArbWaveformComplexF64

C Function Prototype

ViStatus niRFSG_WriteArbWaveformComplexF64 (ViSession vi, ViConstString waveformName, ViInt32 numberOfSamples, NIComplexNumber wfmData[], ViBoolean moreDataPending);

Purpose

Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. This function accepts the complex baseband data in the form of complex doubles. If the waveform to write is already allocated using the niRFSG_AllocateArbWaveform function, the moreDataPending parameter is ignored. The PXI-5670/5671 must be in the Configuration state before you call this function. When streaming is enabled, you can call this function when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840/5841 is in the Generation state.

| Note |Note On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841, the moreDataPending parameter is always ignored. To write data in blocks on these devices, you must allocate the waveform before writing it.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |numberOfSamples|ViInt32|Specifies the number of samples in both of the data arrays.| |data|NIComplexNumber[]|Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the size_in_samples parameter in the niRFSG_AllocateArbWaveform function.| |moreDataPending|ViBoolean|Specifies whether or not the data block contains the end of the waveform. Set this parameter to VI_TRUE to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set moreDataPending to VI_FALSE to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.|

Return Value

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:

|

niRFSG_WriteArbWaveformComplexF32

C Function Prototype

ViStatus niRFSG_WriteArbWaveformComplexF32 (ViSession vi, ViConstString waveformName, ViInt32 numberOfSamples, NIComplexNumberF32 wfmData[], ViBoolean moreDataPending);

Purpose

Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. This function accepts the complex baseband data in the form of complex singles. If the waveform to write is already allocated using the niRFSG_AllocateArbWaveform function, the moreDataPending parameter is ignored. The PXI-5670/5671 must be in the Configuration state before you call this function. When streaming is enabled, you can call this function when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840/5841 is in the Generation state.

| Note |Note On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841, the moreDataPending parameter is always ignored. To write data in blocks on these devices, you must allocate the waveform before writing it.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |numberOfSamples|ViInt32|Specifies the number of samples in both of the data arrays.| |data|NIComplexNumberF32[]|Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the size_in_samples parameter in the niRFSG_AllocateArbWaveform function.| |moreDataPending|ViBoolean|Specifies whether or not the data block contains the end of the waveform. Set this parameter to VI_TRUE to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set moreDataPending to VI_FALSE to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.|

Return Value

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:

|

niRFSG_WriteArbWaveformComplexI16

C Function Prototype

ViStatus niRFSG_WriteArbWaveformComplexI16 (ViSession vi, ViConstString waveformName, ViInt32 numberOfSamples, NIComplexI16 wfmData[]);

Purpose

Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory. This function accepts the interleaved I/Q data of a complex baseband signal. The PXI-5670/5671 must be in the Configuration state before you call this function. When streaming is enabled, this function can be called when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840/5841 is in the Generation state.

| Note |Note This function only supports NIRFSG_VAL_PEAK_POWER mode as specified in the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute. If you download a waveform when using this function, you cannot set the NIRFSG_ATTR_POWER_LEVEL_TYPE to NIRFSG_VAL_AVERAGE_POWER without causing error in the output.| Supported Devices: PXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |numberOfSamples|ViInt32|Specifies the number of samples in the data array.| |data|NIComplexI16[]|Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the size_in_samples parameter in the niRFSG_AllocateArbWaveform function.|

Return Value

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:

|

niRFSG_CheckIfWaveformExists

C Function Prototype

ViStatus niRFSG_CheckIfWaveformExists (ViSession vi, ViConstString waveformName, ViBoolean* waveformExists);

Purpose

Returns whether the waveform that you specify as waveformName exists.

Supported Devices: PXIe-5673/5673E

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.| |waveformName|ViConstString|Specifies the name used to store the waveform. This string is case-insensitive.| |Output||| |Name|Type|Description| |waveformExists|ViBoolean*|Returns VI_TRUE if the waveform exists.

Defined Values: |

Return Value

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:

|

niRFSG_ReadAndDownloadWaveformFromFileTDMS

C Function Prototype

ViStatus niRFSG_ReadAndDownloadWaveformFromFileTDMSComplexI16 (ViSession vi, ViConstString waveformName, ViConstString filePath, ViUInt32 waveformIndex);

Purpose

Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.

This function reads the following information from the TDMS file and writes it into the NI-RFSG session:

Sample Rate
PAPR
Runtime Scaling
RF Blanking Marker Locations
RF Blanking Enabled
Burst Start Locations
Burst Stop Locations
RF Blanking Marker Source
Signal Bandwidth
Waveform Size

If RF blanking marker locations are present in the file but burst locations are not present, burst locations are calculated from RF blanking marker locations and stored in the NI-RFSG session.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the name used to store the waveform. This string is case-insensitive.

Example:

"waveform::waveform0"

Return Value

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:

|

niRFSG_SelectArbWaveform

C Function Prototype

ViStatus niRFSG_SelectArbWaveform (ViSession vi, ViConstString name);

Purpose

Specifies the waveform that is generated upon a call to the niRFSG_Initiate function when the generationMode parameter of the niRFSG_ConfigureGenerationMode function is set to NIRFSG_VAL_ARB_WAVEFORM. You must specify a waveform using the name parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Assigning Properties or Attributes to a Waveform

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.| |name|ViConstString|Specifies the name of the stored waveform to generate. This is a case-insensitive alphanumeric string that does not use reserved words. NI-RFSG sets the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute to this value.|

Return Value

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:

|

niRFSG_ClearArbWaveform

C Function Prototype

ViStatus niRFSG_ClearArbWaveform (ViSession vi, ViConstString name);

Purpose

Deletes a specified waveform from the pool of currently defined waveforms. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

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.| |name|ViConstString|Name of the stored waveform to delete.|

Return Value

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:

|

niRFSG_ClearAllArbWaveforms

C Function Prototype

ViStatus niRFSG_ClearAllArbWaveforms (ViSession vi);

Purpose

Deletes all currently defined waveforms and scripts. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

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

Return Value

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:

|

niRFSG_ConfigureDigitalModulationUserDefinedWaveform

C Function Prototype

ViStatus niRFSG_ConfigureDigitalModulationUserDefinedWaveform (ViSession vi, ViInt32 numberOfSamples, ViInt8 userDefinedWaveform[]);

Purpose

Specifies the message signal used for digital modulation when the NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE attribute is set to NIRFSG_VAL_USER_DEFINED.

Supported Devices: PXI/PXIe-5650/5651/5652

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.| |numberOfSamples|ViInt32|Specifies the number of samples in the message signal.| |userDefinedWaveform|ViInt8[]|Specifies the user-defined message signal used for digital modulation.|

Return Value

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:

|

niRFSG_AllocateArbWaveform

C Function Prototype

ViStatus niRFSG_AllocateArbWaveform (ViSession vi, ViConstString name, ViInt32 size_in_samples);

Purpose

Allocates onboard memory space for the arbitrary waveform. Use this function to specify the total size of a waveform before writing the data. Use this function only if you are calling the niRFSG_WriteArbWaveform function multiple times to write a large waveform in smaller blocks.

The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Streaming Waveform Data

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.| |name|ViConstString|Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.| |size_in_samples|ViInt32|Specifies the number of samples to reserve in the onboard memory for the specified waveform. Each I/Q pair is considered one sample.|

Return Value

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:

|

niRFSG_ConfigureSignalBandwidth

C Function Prototype

ViStatus niRFSG_ConfigureSignalBandwidth (ViSession vi, ViReal64 signalBandwidth);

Purpose

Configures the signal bandwidth of the arbitrary waveform. The NI-RFSG device must be in the Configuration state before you call this function.

NI-RFSG defines signal bandwidth as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0 Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or fmax minus fmin. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion.

| Note |Note Based on your signal bandwidth, NI-RFSG decides whether to configure the upconverter center frequency on the PXI-5670/5671 or PXIe-5672 in increments of 1 MHz or 5 MHz. Failure to configure signal bandwidth may result in the signal being placed outside the upconverter passband.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

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.| |signalBandwidth|ViReal64|Specifies the signal bandwidth used by NI-RFSG to generate an RF output signal. NI-RFSG sets the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute to this value.|

Return Value

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:

|

niRFSG_SetArbWaveformNextWritePosition

C Function Prototype

ViStatus niRFSG_SetArbWaveformNextWritePosition (ViSession vi, ViConstString name, ViInt32 Relative_To, ViInt32 Offset);

Purpose

Configures the start position to use for writing a waveform before calling the niRFSG_WriteArbWaveform function. This function allows you to write to arbitrary locations within the waveform. These settings apply only to the next write to the waveform specified by the name input of the niRFSG_AllocateArbWaveform function or the niRFSG_WriteArbWaveform function. Subsequent writes to that waveform begin where the last write ended, unless this function is called again.

| Note |Note If you use this function to write the waveform that is currently generating, an undefined output may result.| Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841

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.| |name|ViConstString|Specifies the name of the waveform. This string is case-insensitive and alphanumeric, and it cannot use reserved words.| |relativeTo|ViInt32|Specifies the reference position in the waveform. The position and offset together determine where to start loading data into the waveform.

Defined Values: |

|NIRFSG_VAL_START_OF_WAVEFORM|The reference position is relative to the start of the waveform.| |NIRFSG_VAL_CURRENT_POSITION|The reference position is relative to the current position.|

|offset|ViInt32|Specifies the offset from the relative to parameter at which to start loading the data into the waveform.|

Return Value

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:

|

niRFSG_ConfigurePowerLevelType

C Function Prototype

ViStatus niRFSG_ConfigurePowerLevelType (ViSession vi, ViInt32 power_level_type);

Purpose

Specifies the way the driver interprets the NIRFSG_ATTR_POWER_LEVEL attribute. In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Spurious Performance

Optimizing for Low Power Generation

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.| |power_level_type|ViInt32|Specifies the way the driver interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. NI-RFSG sets the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to this value.|

|Average Power (default)|Indicates the desired power averaged in time. The driver maximizes the dynamic range by scaling the I/Q waveform so that its peak magnitude is equal to one. If you write more than one waveform, NI-RFSG scales each waveform without preserving the power level ratio between the waveforms. This value is not valid for the PXIe-5820. | |Peak Power|Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires the magnitude of the I/Q waveform to be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute. |

Return Value

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:

|

Burst Location

niRFSG_SetWaveformBurstStartLocations

C Function Prototype

ViStatus niRFSG_SetWaveformBurstStartLocations ComplexI16 (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations);

Purpose

Configures the burst start locations of waveform that you specify in the locations parameter.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

|| |numberOfLocations|NIComplexI16[]||Specifies the size of the burst start locations array.| |locations|ViReal64|Specifies the burst start locations to store in the NI-RFSG session.||

Return Value

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:

|

niRFSG_SetWaveformBurstStopLocations

C Function Prototype

ViStatus niRFSG_SetWaveformBurstStopLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations);

Purpose

Configures the burst stop locations of waveform that you specify in the locations parameter.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

Return Value

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:

|

niRFSG_GetWaveformBurstStartLocations

C Function Prototype

ViStatus niRFSG_GetWaveformBurstStartLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations, ViInt32* requiredSize);

Purpose

Returns the burst start locations of the waveform stored in the NI-RFSG session.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

|| |data|NIComplexI16[]||Specifies the size of the burst start locations array.| |Output|||| |Name|Type|Description|| |locations|ViReal64|Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the channelName parameter..|| |requiredSize|ViInt32*|Returns the required size for the output array if you pass NULL to Locations parameter. ||

Return Value

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:

|

niRFSG_GetWaveformBurstStopLocations

C Function Prototype

ViStatus niRFSG_GetWaveformBurstStopLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations, ViInt32* requiredSize);

Purpose

Returns the burst stop locations of the waveform stored in the NI-RFSG session.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

|| |numberOfLocations|NIComplexI16[]||Specifies the size of the burst stop locations array.| |Output|||| |Name|Type|Description|| |locations|ViReal64|Returns the burst stop locations stored in the NI-RFSG session for the waveform that you specified in the channelName parameter.|| |requiredSize|ViInt32*|Returns the required size for the output array if you pass NULL to Locations parameter. ||

Return Value

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:

|

Marker Event

niRFSG_SetWaveformMarkerEventLocations

C Function Prototype

ViStatus niRFSG_SetWaveformMarkerEventLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations);

Purpose

Configures the marker locations associated with waveform and marker in the NI-RFSG session.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

Return Value

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:

|

niRFSG_GetWaveformMarkerEventLocations

C Function Prototype

ViStatus niRFSG_GetWaveformMarkerEventLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations, ViInt32* requiredSize);

Purpose

Returns the marker locations associated with the waveform and the marker stored in the NI-RFSG session.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |numberOfLocations|NIComplexI16[]|Specifies the size of the locations array.| |Output||| |Name|Type|Description| |locations|ViReal64|Returns the marker locations stored in the NI-RFSG database for the channel you specified in the channelName parameter.| |requiredSize|ViInt32*|Returns the required size for the output array if you pass NULL to Locations parameter. |

Return Value

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:

|

Configure List

niRFSG_CreateConfigurationList

C Function Prototype

ViStatus niRFSG_CreateConfigurationList (ViSession vi, ViConstString listName, ViInt32 numberOfAttributes, const ViAttr configurationListAttributes[], ViBoolean setAsActiveList);

Purpose

Creates an empty configuration list. Use the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute to enable a configuration list created by this function. Call the niRFSG_CreateConfigurationListStep function to add steps to the configuration list.

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

Related Topics

RF List Mode

Using RF List Mode

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.| |listName|ViConstString|Specifies the name of the configuration list. This string is case-insensitive and alphanumeric, and it cannot contain spaces or use reserved words.| |numberOfAttributes|const ViInt32|Specifies size of the configurationListAttributes parameter. | |configurationListAttributes|const ViAttr[]|Specifies the attributes that you intend to change between configuration list steps. Calling the niRFSG_CreateConfigurationList function allocates space for each of the configuration list attributes. When you use an NI-RFSG Set attribute function to set one of the attributes in the configuration list, that attribute is set for one of the configuration list steps. Use the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST_STEP attribute to specify which configuration list step to configure.

You can include the following attributes in your configuration list based on your device:|

|Attribute|PXIe5644/5646|PXIe5645|PXIe5650/5651/5652|PXIe5653|PXIe5654|PXIe5654/5654 with PXIe5696|PXIe5673E|PXIe5820|PXIe5830/5831/5832|PXIe5840/5841| |NIRFSG_ATTR_ALC_CONTROL||||||✓||||| |NIRFSG_ATTR_AMP_PATH||||||✓||||| |NIRFSG_ATTR_AMPLITUDE_SETTLING|||||✓|✓||✓|✓|✓| |NIRFSG_ATTR_ATTENUATOR_SETTING||||||✓||||| |NIRFSG_ATTR_AUTO_POWER_SEARCH||||||✓||||| |NIRFSG_ATTR_ARB_DIGITAL_GAIN|✓|✓||||||✓|✓|✓| |NIRFSG_ATTR_EXTERNAL_GAIN||||||||✓|✓|✓| |NIRFSG_ATTR_FREQUENCY|✓|✓|✓|✓|✓|✓|✓|✓||✓| |NIRFSG_ATTR_FREQUENCY_SETTLING|||✓|✓|✓|✓|✓|||✓| |NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY||✓||||||✓||| |NIRFSG_ATTR_IQ_OUT_PORT_COMMON_MODE_OFFSET||✓||||||✓||| |NIRFSG_ATTR_IQ_OUT_PORT_LEVEL||✓||||||✓||| |NIRFSG_ATTR_IQ_OUT_PORT_OFFSET||✓||||||✓||| |NIRFSG_ATTR_OUTPUT_ENABLED|||||✓|✓||||| |NIRFSG_ATTR_PHASE_OFFSET|✓|✓|✓|✓|||✓|✓|✓|✓| |NIRFSG_ATTR_POWER_LEVEL|✓|✓|✓||✓|✓|✓||✓|✓| |NIRFSG_ATTR_ARB_PRE_FILTER_GAIN|||||||✓|✓|✓|✓| |NIRFSG_ATTR_PULSE_MODULATION_ENABLED|||||✓|✓|✓|||| |NIRFSG_ATTR_SELECTED_PORTS|||||||||✓|| |NIRFSG_ATTR_SIGNAL_BANDWIDTH||||||||✓||✓| |NIRFSG_ATTR_TIMER_EVENT_INTERVAL|✓|✓|✓||✓|✓|✓|✓|✓|✓| |NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY|✓|✓|||||✓|||✓| |NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY_OFFSET||||||||||✓|

|setAsActiveList|ViBoolean|Sets this list as the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute when this parameter is enabled. NI recommends that you set this parameter to VI_TRUE when creating the list.|

Return Value

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:

|

niRFSG_CreateConfigurationListStep

C Function Prototype

ViStatus niRFSG_CreateConfigurationListStep (ViSession vi, ViBoolean setAsActiveStep);

Purpose

Creates a new configuration list step in the configuration list specified by the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute. When you create a configuration list step, a new instance of each attribute specified by the configuration list attributes is created. Configuration list attributes are specified when a configuration list is created. The new instance of an attribute can be accessed with any Set attribute function using the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST and NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST_STEP attributes.

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

Related Topics

RF List Mode

Using RF List Mode

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.| |setAsActiveStep|ViBoolean|Sets this step as the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST_STEP attribute list specified by the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute. NI recommends that you set this parameter to VI_TRUE when creating the list steps.|

Return Value

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:

|

niRFSG_CheckIfConfigurationListExists

C Function Prototype

ViStatus niRFSG_CheckIfConfigurationListExists (ViSession vi, ViConstString listName, ViBoolean* listExists);

Purpose

Returns whether the configuration list that you specify as listName exists.

Supported Devices: PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

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.| |listName|ViConstString|Specifies the name of the configuration list. This string is case-insensitive.| |Output||| |Name|Type|Description| |listExists|ViBoolean*|Returns VI_TRUE if the configuration list exists.

Defined Values: |

Return Value

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:

|

niRFSG_DeleteConfigurationList

C Function Prototype

ViStatus niRFSG_DeleteConfigurationList (ViSession vi, ViConstString listName);

Purpose

Deletes a previously created configuration list and all the configuration list steps in the specified configuration list. When a configuration list step is deleted, all the instances of the attributes associated with the configuration list step are also removed. When you delete the active configuration list, NI-RFSG automatically resets the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute to "" (empty string), which indicates no list is active, and the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST_STEP attribute to 0.

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

Related Topics

RF List Mode

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.| |listName|ViConstString|Specifies the name of the configuration list. This string is case-insensitive and alphanumeric, and it cannot contain spaces or use reserved words.|

Return Value

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:

|

Configure Trigger

Start Trigger

niRFSG_ConfigureSoftwareStartTrigger

C Function Prototype

ViStatus niRFSG_ConfigureSoftwareStartTrigger (ViSession vi);

Purpose

Configures the Start Trigger for software triggering. Refer to the niRFSG_SendSoftwareEdgeTrigger function for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Start Trigger

Trigger Types

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

Return Value

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:

|

niRFSG_ConfigureDigitalEdgeStartTrigger

C Function Prototype

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

Purpose

Configures the Start Trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before calling this function.

| Note |Note For the PXIe-5654/5654 with PXIe-5696, the Start Trigger is valid only with a timer-based list when RF list mode is enabled.| Supported Devices: PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Start Trigger

Digital Edge Trigger

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.| |source|ViConstString|Specifies the source terminal for the digital edge trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute to this value. | |edge|ViInt32|Specifies the active edge for the Start Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute to this value.|

Return Value

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:

|

niRFSG_ConfigureP2PEndpointFullnessStartTrigger

C Function Prototype

ViStatus niRFSG_ConfigureP2PEndpointFullnessStartTrigger (ViSession vi, ViInt64 p2pEndpointFullnessLevel);

Purpose

Configures the Start Trigger to detect peer-to-peer endpoint fullness. Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the p2pEndpointFullnessLevel parameter. The NI-RFSG device must be in the Configuration state before calling this function.

| Note |Note Due to an additional internal FIFO in the RF signal generator, the writer peer actually writes 2,304 bytes more than the quantity of data specified by this function to satisfy the trigger level.| Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Start Trigger

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.| |p2pEndpointFullnessLevel|ViInt64|Specifies the quantity of data in the FIFO endpoint that asserts the trigger. Units are samples per channel. The default value is -1, which allows NI-RFSG to select the appropriate fullness value.|

Return Value

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:

|

niRFSG_DisableStartTrigger

C Function Prototype

ViStatus niRFSG_DisableStartTrigger (ViSession vi);

Purpose

Configures the device not to wait for a Start Trigger. This function is necessary only if you previously configured a Start Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before calling this function.

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

Related Topics

Start Trigger

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

Return Value

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:

|

Script Trigger

niRFSG_ConfigureSoftwareScriptTrigger

C Function Prototype

ViStatus niRFSG_ConfigureSoftwareScriptTrigger (ViSession vi, ViConstString triggerIdentifier);

Purpose

Configures the Script Trigger for software triggering. Refer to the niRFSG_SendSoftwareEdgeTrigger function for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Script Trigger

Trigger Types

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.| |triggerIdentifier|ViConstString|Specifies the Script Trigger to configure.|

Return Value

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:

|

niRFSG_ConfigureDigitalEdgeScriptTrigger

Specific Function

C Function Prototype

ViStatus niRFSG_ConfigureDigitalEdgeScriptTrigger (ViSession vi, ViConstString triggerIdentifier, ViConstString source, ViInt32 edge);

Purpose

Configures the specified Script Trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Script Trigger

Digital Edge Trigger

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.| |triggerIdentifier|ViConstString|Specifies the Script Trigger to configure.| |source|ViConstString|Specifies the source terminal for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE attribute to this value.| |edge|ViInt32|Specifies the active edge for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE attribute to this value.|

Return Value

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:

|

niRFSG_ConfigureDigitalLevelScriptTrigger

C Function Prototype

ViStatus niRFSG_ConfigureDigitalLevelScriptTrigger (ViSession vi, ViConstString Trigger_Identifier, ViConstString Source, ViInt32 Level);

Purpose

Configures a specified Script Trigger for digital level triggering. The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Script Trigger

Digital Level Trigger

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.| |triggerIdentifier|ViConstString|Specifies the Script Trigger to configure.| |source|ViConstString|Specifies the trigger source terminal for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute to this value. | |Level|ViInt32|Specifies the active level for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL attribute to this value. |

Return Value

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:

|

niRFSG_DisableScriptTrigger

Specific Function

C Function Prototype

ViStatus niRFSG_DisableScriptTrigger (ViSession vi, ViConstString Trigger_Identifier);

Purpose

Configures the device not to wait for the specified Script Trigger. Call this function only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Script Trigger

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.| |triggerIdentifier|ViConstString|Specifies the Script trigger to configure.|

Return Value

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:

|

niRFSG_SendSoftwareEdgeTrigger

C Function Prototype

ViStatus niRFSG_SendSoftwareEdgeTrigger (ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier);

Purpose

Forces a trigger to occur. The specified trigger generates regardless of whether the trigger has been configured as a software trigger.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

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

Specifies the trigger to send.

Defined Values:

|

|||Default Value: NIRFSG_VAL_START_TRIGGER| |triggerIdentifier|ViConstString|

Specifies the Script Trigger to configure. This parameter is valid only when you set the trigger parameter to NIRFSG_VAL_SCRIPT_TRIGGER. Otherwise, set the triggerIdentifier parameter to "" (empty string).

Defined Values:

|

|||Default Value: "" (empty string)|

Return Value

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:

|

niRFSG_ConfigureDigitalEdgeConfigurationListStepTrigger

C Function Prototype

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

Purpose

Configures the Configuration List Step trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before you call this function.

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

Related Topics

RF List Mode

Using RF List Mode

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.| |source|ViConstString|Specifies the trigger source terminal for the digital edge Configuration List Step trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_SOURCE attribute to this value. Refer to this attribute for possible values.| |edge|ViInt32|Specifies the active edge for the digital edge Configuration List Step trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_EDGE attribute to this value.|

Return Value

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:

|

niRFSG_DisableConfigurationListStepTrigger

C Function Prototype

ViStatus niRFSG_DisableConfigurationListStepTrigger (ViSession vi)

Purpose

Configures the device not to receive triggers for the configuration list. The configuration list does not advance steps if this trigger is disabled. Call this function only if a previously configured trigger needs to be disabled. The NI-RFSG device must be in the Configuration state before you call this function.

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

Related Topics

RF List Mode

Using RF List Mode

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

Return Value

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:

|

niRFSG_GetTerminalName

C Function Prototype

ViStatus niRFSG_GetTerminalName (ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViInt32 bufferSize, ViChar terminalName[]);

Purpose

Returns the fully-qualified name of the specified signal. The fully-qualified name is helpful to automatically route signals in a multisegment chassis.

Supported Devices: 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

Related Topics

Triggers

Events

Syntax for Terminal Names

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.| |signal|ViInt32|Specifies the signal to query.

Defined Values: |

|signalIdentifier|ViConstString|Specifies which instance of the selected signal to query. This parameter is necessary when you set the signal parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the signalIdentifier parameter to "" (empty string).

Defined Values: |

|bufferSize|ViInt32|Pass the number of bytes in the ViChar buffer you specify for the terminalName parameter.

If you pass 0, you can pass VI_NULL for the terminalName parameter.| |Output||| |Name|Type|Description| |terminalName|ViChar[]|Returns the string to use as the source for other devices. |

Return Value

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 status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

|

Configure Clock

niRFSG_ConfigureRefClock

C Function Prototype

ViStatus niRFSG_ConfigureRefClock (ViSession vi, ViConstString clockSource, ViReal64 refClockRate);

Purpose

Configures the NI-RFSG device Reference Clock. The Reference Clock ensures that the NI-RFSG devices are operating from a common timebase. The NI-RFSG device must be in the Configuration state before calling this function.

Supported Devices: PXI-5610, PXIe-5644/5645/5646, 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

Related Topics

PXIe-5672 Timing Configurations

PXIe-5673 Timing Configurations

PXIe-5673E Timing Configurations

[PXIe-5830 Timing Configurations](javascript:LaunchMergedHelp('RFSG.chm', 'PXIe-5830.chm', 'timing-configurations.html'))

[PXIe-5831 Timing Configurations](javascript:LaunchMergedHelp('RFSG.chm', 'PXIe-5831.chm', 'timing-configurations.html'))

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.| |refClockSource|ViConstString|Specifies the source of Reference Clock signal.

PXIe-5841 with PXIe-5655—Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. |

|NIRFSG_VAL_ONBOARD_CLOCK_STR (default)|Uses the onboard Reference Clock as the clock source.

PXIe-5830/5831/5832—For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector.

PXIe-5831 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector.

PXIe-5832 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. | |NIRFSG_VAL_REF_IN_STR|Uses the clock signal present at the front panel REF IN connector as the clock source.

PXIe-5830/5831/5832—For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe- 3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector.

PXIe-5831 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5832 with PXIe-5653—Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5841 with PXIe-5655—Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector.| |NIRFSG_VAL_PXI_CLK_STR|Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source.| |NIRFSG_VAL_CLK_IN_STR|Uses the clock signal present at the front panel CLK IN connector as the clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655.| |NIRFSG_VAL_REF_IN_2_STR|| |NIRFSG_VAL_PXI_CLK_MASTER_STR|This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.

**PXIe-5831 with PXIe-5653—**NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.

**PXIe-5832 with PXIe-5653—**NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. |

|refClockRate|ViReal64|Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the refClockSource parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR, or NIRFSG_VAL_REF_IN_2_STR. Refer to the [NIRFSG_ATTR_REF_CLOCK_RATE](javascript:LaunchMergedHelp('RFSG.chm', 'CVIrfsg.chm', 'NIRFSG_ATTR_REF_CLOCK_RATE.html')) attribute for possible values.|

Return Value

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:

|

niRFSG_ConfigurePXIChassisClk10

C Function Prototype

ViStatus niRFSG_ConfigurePXIChassisClk10 (ViSession vi, ViConstString pxiClk10Source);

Purpose

Specifies the signal to drive the 10 MHz Reference Clock on the PXI backplane. This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: PXI-5610, PXI-5670/5671

Related Topics

Timing Configurations

System Reference Clock

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.| |pxiClk10Source|ViConstString|Specifies the source of the Reference Clock signal. |

Return Value

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:

|

niRFSG_ExportSignal

C Function Prototype

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

Purpose

Routes signals (triggers, clocks, and events) to a specified output terminal. The NI-RFSG device must be in the Configuration state before you call this function.

You can clear a previously routed signal by exporting the signal to "" (empty string).

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

Related Topics

Triggers

Events

PFI Lines

PXI Trigger Lines

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

Defined Values: |

|signalIdentifier|ViConstString|Specifies which instance of the selected signal to export. This parameter is useful when you set the signal parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the signalIdentifier parameter to "" (empty string).

Defined Values: |

|outputTerminal|ViConstString|Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841.

Defined Values: |

Return Value

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:

|

De Embedding

niRFSG_CreateDeembeddingSparameterTableS2PFile

ViStatus niRFSG_CreateDeembeddingSparameterTableS2PFile (ViSession vi, ViConstString port, ViConstString tableName, ViConstString s2pFilePath, ViInt32 sparameterOrientation);

Purpose

Creates an S-parameter de-embedding table for the port based on the specified S2P file.

If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Related Topics

De-embedding Overview

S-parameters

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced. | |s2pFilePath|ViConstString|Specifies the path to the S2P file that contains de-embedding information for the specified port.| |sparameterOrientation|ViInt32|Specifies the orientation of the data in the S2P file relative to the port on the DUT port.|

|NIRFSG_VAL_PORT1_TOWARDS_DUT (3800)|Port 1 of the S2P is oriented towards the DUT port.| |NIRFSG_VAL_PORT2_TOWARDS_DUT (3801)|Port 2 of the S2P is oriented towards the DUT port.|

Return Value

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:

|

niRFSG_CreateDeembeddingSparameterTableArray

ViStatus niRFSG_CreateDeembeddingSparameterTableArray (ViSession vi, ViConstString port, ViConstString tableName, const ViReal64 frequencies[], ViInt32 frequenciesSize, const NIComplexNumber sparameterTable[], ViInt32 sparameterTableSize, ViInt32 numberOfPorts, ViInt32 sparameterOrientation);

Purpose

Creates an s-parameter de-embedding table for the port from the input data.

If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.

Supported Devices: PXIe-5830/5831/5832/5840/5841

Related Topics

De-embedding Overview

S-parameters

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced. | |frequencies|const ViReal64[]|Specifies the frequencies for the sparameterTable rows. Frequencies must be unique and in ascending order.| |frequenciesSize|ViInt32|Specifies the size of the frequency.| |sparameterTable|const NIComplexNumber[]|Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22. | |sparameterTableSize|ViInt32|Specifies the size of the S-parameter table.| |numberOfPorts|ViInt32|Specifies the number of DUT ports.| |sparameterOrientation|ViInt32|Specifies the orientation of the data in the S2P file relative to the port on the DUT port.|

|NIRFSG_VAL_PORT1_TOWARDS_DUT (3800)|Port 1 of the S2P is oriented towards the DUT port.| |NIRFSG_VAL_PORT2_TOWARDS_DUT (3801)|Port 2 of the S2P is oriented towards the DUT port.|

Return Value

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:

|

niRFSG_DeleteDeembeddingTable

ViStatus niRFSG_DeleteDeembeddingTable (ViSession vi, ViConstString port, ViInt32 numberOfListAttributes, ViConstString tableName);

Purpose

Deletes the selected de-embedding table for a given port.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table.|

Return Value

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:

|

niRFSG_DeleteAllDeembeddingTables

ViStatus niRFSG_DeleteAllDeembeddingTables (ViSession vi);

Purpose

Deletes all configured de-embedding tables for the session.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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

Return Value

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:

|

niRFSG_ConfigureDeembeddingTableInterpolationNearest

ViStatus niRFSG_ConfigureDeembeddingTableInterpolationNearest (ViSession vi, ViConstString port, ViConstString tableName);

Purpose

Selects the nearest interpolation method. NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table.|

Return Value

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:

|

niRFSG_ConfigureDeembeddingTableInterpolationLinear

ViStatus niRFSG_ConfigureDeembeddingTableInterpolationLinear (ViSession vi, ViConstString port, ViConstString tableName, ViInt32 format);

Purpose

Selects the linear interpolation method. If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a linear interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table.| |format|ViInt32|Specifies the format of parameters to interpolate.|

|NIRFSG_VAL_LINEAR_INTERPOLATION_FORMAT_REAL_AND_IMAGINARY (4000)|Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.| |NIRFSG_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_AND_PHASE (4001)|Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.| |NIRFSG_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_DB_AND_PHASE (4002)|Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.|

Return Value

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:

|

niRFSG_ConfigureDeembeddingTableInterpolationSpline

ViStatus niRFSG_ConfigureDeembeddingTableInterpolationSpline (ViSession vi, ViConstString port, ViConstString tableName);

Purpose

Selects the spline interpolation method. If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a spline interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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.| |port|ViConstString|Specifies the name of the port. The only valid value for the PXIe-5840/5841 is "" (empty string).| |tableName|ViConstString|Specifies the name of the table.|

Return Value

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:

|

niRFSG_GetDeembeddingSparameters

ViStatus niRFSG_GetDeembeddingSparameters (ViSession vi, NIComplexNumber *sparameters, ViInt32 sparametersArraySize, ViInt32 *numberOfSparametersReturned, ViInt32 *numberOfPorts);

Purpose

Returns the S-parameters used for de-embedding a measurement on the selected port. This includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is completed.

If you want to call this function just to get the required buffer size, you can pass 0 for S-parameter Size and VI_NULL for the S-parameters buffer.

Supported Devices: PXIe-5830/5831/5832/5840/5841

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.| |sparametersArraySize|ViInt32|Specifies the size of the array that is returned by the sparameters output.| |Output||| |Name|Type|Description| |sparameters|NIComplexNumber*|Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22. | |numberOfSparametersReturned|ViInt32*|Returns the number of S-parameters.| |numberOfPorts|ViInt32*|Returns the number of S-parameter ports. The sparameter array is always n x n, where span n is the number of ports.|

Return Value

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:

|

Peer To Peer (P2P)

niRFSG_GetStreamEndpointHandle

C Function Prototype

ViStatus niRFSG_GetStreamEndpointHandle (ViSession vi, ViConstString streamEndpoint, ViUInt32* readerHandle);

Purpose

Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint.

Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Configuring a Peer-to-Peer Endpoint

Configuring Flow Control

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.| |streamEndpoint|ViConstString|Specifies the stream endpoint FIFO to configure.| |Output||| |Name|Type|Description| |readerHandle|ViUInt32*|Returns the reader endpoint handle that is used with NI-P2P to create a stream with the NI-RFSG device as an endpoint.|

Return Value

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:

|

niRFSG_WriteP2PEndpointI16

C Function Prototype

ViStatus niRFSG_WriteP2PEndpointI16 (ViSession vi, ViConstString streamEndpoint, ViInt32 numberOfSamples, ViInt16 endpointData[])

Purpose

Writes an array of 16-bit integer data to the peer-to-peer endpoint. Use this function to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation.

Supported Devices: PXIe-5673E

Related Topics

Peer-to-Peer Data Streaming—Refer to this topic for more information about configuring a stream.

Configuring Flow Control

Starting Peer-to-Peer Generation

Reconfiguring a Stream

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.| |streamEndpoint|ViConstString|Specifies the stream endpoint FIFO to configure.| |numberOfSamples|ViInt32|Specifies the number of samples to write into the endpoint FIFO.| |endpointData|ViInt16 []|Specifies the array of data to write into the endpoint FIFO. The binary data is left-justified.|

Return Value

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:

|

Scripting

niRFSG_CheckIfScriptExists

C Function Prototype

ViStatus niRFSG_CheckIfScriptExists (ViSession vi, ViConstString scriptName, ViBoolean* scriptExists);

Purpose

Returns whether the script that you specify as scriptName exists.

Supported Devices: PXIe-5673/5673E

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.| |scriptName|ViConstString|Specifies the name of the script. This string is case-insensitive.| |Output||| |Name|Type|Description| |scriptExists|ViBoolean*|Returns VI_TRUE if the script exists.

Defined Values: |

Return Value

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:

|

niRFSG_WriteScript

C Function Prototype

ViStatus niRFSG_WriteScript (ViSession vi, ViConstString script);

Purpose

Writes a script to the device to control waveform generation in Script mode. First, configure your device for Script mode by calling the niRFSG_ConfigureGenerationMode function. The NI-RFSG device must be in the Configuration state before calling the niRFSG_WriteScript function.

| Note |Note If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported.| Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

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

Common Scripting Use Cases

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.| |script|ViConstString|Specifies a string containing a syntactically correct script. NI-RFSG supports multiple scripts that are selected with the NIRFSG_ATTR_SELECTED_SCRIPT for more information about using scripts. |

Return Value

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:

|

niRFSG_ConfigureOutputEnabled

C Function Prototype

ViStatus niRFSG_ConfigureOutputEnabled (ViSession vi, ViBoolean output_enabled);

Purpose

Enables or disables signal output. Setting output_enabled to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.

Supported Devices: PXI-5610, PXIe-5611, 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

Related Topics

Output Enabled

NI-RFSG Instrument Driver Programming Flow

RF List Mode

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.| |output_enabled|ViBoolean|Specifies whether you want to enable or disable the output.|

Return Value

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:

|

niRFSG_ConfigureIQEnabled

C Function Prototype

ViStatus niRFSG_ConfigureIQEnabled (ViSession vi, ViBoolean enabled);

Purpose

Configures the NI-RFSG device to apply I/Q (vector) modulation to the RF output signal. I/Q modulation must be enabled in order to generate any arbitrary (non-sine) waveform; if I/Q modulation is disabled, a sine tone is always generated, regardless if an arbitrary waveform is written. The NI-RFSG device must be in the Configuration state before calling this function.

||Note This function is obsolete. Use the NIRFSG_ATTR_GENERATION_MODE attribute to enable I/Q modulation instead.| Upon device initialization, or calling the niRFSG_reset function or the niRFSG_ResetDevice function, I/Q modulation is disabled.

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.| |enabled|ViBoolean|NI-RFSG sets the NIRFSG_ATTR_IQ_ENABLED attribute to this value.

Defined Values: |

Return Value

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:

|

Set/get/check Attribute

Set Attribute

niRFSG_SetAttributeViInt32

C Function Prototype

ViStatus niRFSG_SetAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 attributeValue);

Purpose

Sets the value of a ViInt32 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_SetAttributeViInt64

C Function Prototype

ViStatus niRFSG_SetAttributeViInt64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt64 Attribute_Value);

Purpose

Sets the value of a ViInt64 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_SetAttributeViReal64

C Function Prototype

ViStatus niRFSG_SetAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64 attributeValue);

Purpose

Sets the value of a ViReal64 attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_SetAttributeViString

C Function Prototype

ViStatus niRFSG_SetAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViConstString attributeValue);

Purpose

Sets the value of a ViString attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_SetAttributeViBoolean

C Function Prototype

ViStatus niRFSG_SetAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean attributeValue);

Purpose

Sets the value of a ViBoolean attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_SetAttributeViSession

C Function Prototype

ViStatus niRFSG_SetAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession attributeValue);

Purpose

Sets the value of a ViSession attribute.

Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid or is different than the value you specify.

NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some values may not be valid. The allowed values depend on the current settings of the instrument session.|

Return Value

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:

|

Get Attribute

niRFSG_GetAttributeViInt32

C Function Prototype

ViStatus niRFSG_GetAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32* attributeValue);

Purpose

Queries the value of a ViInt32 attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |Output||| |Name|Type|Description| |attributeValue|ViInt32*|Returns the current value of the attribute. Pass the address of a ViInt32 variable.|

Return Value

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:

|

niRFSG_GetAttributeViInt64

C Function Prototype

ViStatus niRFSG_GetAttributeViInt64 (ViSession vi, ViConstString Channel_Name, ViAttr Attribute_ID, ViInt64* Attribute_Value);

Purpose

Queries the value of a ViInt64 attribute.

You can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |Output||| |Name|Type|Description| |Attribute_Value|ViInt64*|Returns the current value of the attribute. Pass the address of a ViInt64 variable.|

Return Value

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:

|

niRFSG_GetAttributeViReal64

C Function Prototype

ViStatus niRFSG_GetAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64* attributeValue);

Purpose

Queries the value of a ViReal64 attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |Output||| |Name|Type|Description| |attributeValue|ViReal64*|Returns the current value of the attribute. Pass the address of a ViReal64 variable.|

Return Value

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:

|

niRFSG_GetAttributeViString

C Function Prototype

ViStatus niRFSG_GetAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 bufferSize, ViChar[] attributeValue);

Purpose

Queries the value of a ViString attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the function copies buffer size-1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the buffer size is 4, the function places "123" into the buffer and returns 7.

To call this function to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the attribute value buffer.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |bufferSize|ViInt32|Pass the number of bytes in the ViChar buffer you specify for the attributeValue parameter.

If you pass 0, you can pass VI_NULL for the attributeValue parameter.| |Output||| |Name|Type|Description| |attributeValue|ViChar[]|The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in the bufferSize parameter.

If you specify 0 for the bufferSize parameter, you can pass VI_NULL for this parameter.|

Return Value

|Name|Type|Description| |status|ViStatus||

niRFSG_GetAttributeViBoolean

C Function Prototype

ViStatus niRFSG_GetAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean* attributeValue);

Purpose

Queries the value of a ViBoolean attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |Output||| |Name|Type|Description| |attributeValue|ViBoolean*|Returns the current value of the attribute. Pass the address of a ViBoolean variable.|

Return Value

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:

|

niRFSG_GetAttributeViSession

C Function Prototype

ViStatus niRFSG_GetAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession* attributeValue);

Purpose

Queries the value of a ViSession attribute.

Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:

State caching is disabled for the entire session or for the particular attribute.
State caching is enabled, and the currently cached value is invalid.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

| |attributeID|ViAttr|Pass the ID of an attribute. | |Output||| |Name|Type|Description| |attributeValue|ViSession*|Returns the current value of the attribute. Pass the address of a ViSession variable.|

Return Value

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:

|

Check Attribute

niRFSG_CheckAttributeViInt32

C Function Prototype

ViStatus niRFSG_CheckAttributeViInt32 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViInt32 attributeValue);

Purpose

Checks the validity of a value you specify for a ViInt32 attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_CheckAttributeViInt64

C Function Prototype

ViStatus niRFSG_CheckAttributeViInt64 (ViSession vi, ViConstString Channel_Name, ViAttr Attribute_ID, ViInt64 Attribute_Value);

Purpose

Checks the validity of a value you specify for a ViInt64 attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_CheckAttributeViReal64

C Function Prototype

ViStatus niRFSG_CheckAttributeViReal64 (ViSession vi, ViConstString channelName, ViAttr attributeID, ViReal64 attributeValue);

Purpose

Checks the validity of a value you specify for a ViReal64 attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_CheckAttributeViString

C Function Prototype

ViStatus niRFSG_CheckAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViConstString attributeValue);

Purpose

Checks the validity of a value you specify for a ViString attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_CheckAttributeViBoolean

C Function Prototype

ViStatus niRFSG_CheckAttributeViBoolean (ViSession vi, ViConstString channelName, ViAttr attributeID, ViBoolean attributeValue);

Purpose

Checks the validity of a value you specify for a ViBoolean attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_CheckAttributeViSession

C Function Prototype

ViStatus niRFSG_CheckAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession attributeValue);

Purpose

Checks the validity of a value you specify for a ViSession attribute.

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

||Note Some of the values might not be valid depending on the current settings of the instrument session.|

Return Value

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:

|

niRFSG_ResetAttribute

C Function Prototype

ViStatus niRFSG_ResetAttribute (ViSession vi, ViConstString channelName, ViAttr attributeId);

Purpose

Resets the attribute to its default value.

Supported Devices: PXI-5610, PXIe-5611, 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

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

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

Return Value

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:

|

NI-DAQmx

gRPC API Differences From C API

Task Configuration And Control

Channel Configuration And Creation

Timing

Triggering

Read Functions

Write Functions

Export Hardware Signals

Scale Configuration

Internal Buffer Configuration

Advanced Functions

System Configuration

Error Handling

Buffer Attributes

Calibration Info Attributes

Channel Attributes

Device Attributes

Export Signal Attributes

Persisted Channel Attributes

Persisted Scale Attributes

Persisted Task Attributes

Physical Channel Attributes

Read Attributes

Scale Attributes

System Attributes

Task Attributes

Timing Attributes

Trigger Attributes

Watchdog Attributes

Write Attributes

NI-DCPOWER

Setup Functions

Configure Functions

Measurement Functions

Control Functions

Trigger And Event
Attribute Functions

Query Functions

Calibration Functions

Utility Functions

Supported Device
Source Attributes

Transient Attributes

Voltage Attributes

Current Attributes

Pulse Voltage Attributes

Pulse Current Attributes

Cutoff Attributes

Measurement Attributes

Trigger Attributes Functions

Event Attributes

Advanced Attributes

Inherent Ivi Attributes

Supported Device Attributes

NI-DIGITAL PATTERN DRIVER

Init And Close Functions

Session Locking Functions

Utility Functions

Error Handling Functions

Calibration Functions

Attributes Functions

Pin Map Functions

Low Level Functions

Low Level Action Functions

Pin Control Functions

Static IO Functions

Clock Generator Functions

Levels And Timing Functions

TDR Functions

PPMU Configuration Functions

DC Voltage Functions

DC Current Functions

PPMU Action Functions

Pattern Configuration Functions

Pattern Action Functions

History Ram Functions

Source Memory Functions

Capture Memory Functions

Triggers And Events Functions

Conditional Jump Trigger Functions

Sequencer Flag Functions

Sequencer Register Functions

Match Fail Combination Functions

Pattern Results Functions

Sort Results Functions

Frequency Measurement Functions

IVI Inherent Attributes

Specific Driver Information Attributes, Read Only

Driver Setup Information Attributes

Device Attributes

Pin Control Attributes

Level Configuration Attributes

Trigger Configuration Attributes

PPMU Attributes

Patterns Attributes

Pattern Opcode Event Attributes

Timing Offset Attributes

Keep Alive Attributes

Frequency Measurement Attributes

Clock Generator Attributes

History RAM

Synchronization Attributes

TDR Endpoint Termination Attributes

NI-DMM

Setup Functions

Configuration Functions

Measurement Functions

Trigger Functions

Values And Attribute Functions

Acquisition Functions

Calibration Functions

Utility Functions

Configuration Attributes

Inherent IVI Attributes

Multi Point Acquisition Attributes

NI-FGEN

Setup Functions

Configuration Functions

Standard Output Functions

Arbitrary Waveform Output Functions

Arbitrary Sequence Output Functions

Incremental Waveform Write Functions

Configure Clock Functions

Trigger And Syncronizations Functions

5404 Routing Functions

Script Output Functions

Configure Onboard Signal Processing Functions

Configure Peer To Peer Functions

Attribute Functions

Waveform Control Functions

Error Functions

Output Attributes

Arbitrary Waveform Attributes

Data Transfer Attributes

Onboard Signal Processing Attributes

Peer To Peer Attributes

Standard Function Attributes

Clock Attributes

Event Attributes

Triggering Attributes

Instrument Specific Attributes

Inherent IVI Attributes

5401 5411 5431

NI-FPGA

gRPC API Differences From C API

NI FPGA C Functions

NI-RFmx Bluetooth

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Fetch Results Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Packet Attributes

Auto Detect Signal Attributes

Modacc Attributes

ACP Attributes

Twenty dB Attributes

Frequency Range Attributes

TXP Attributes

Advanced Attributes

NI-RFmx NR

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attributes Functions

Fetch Results Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Signal Detection Attributes

Component Carrier Attributes

List Attributes

Modacc Attributes

ACP Attributes

CHP Attributes

OBW Attributes

SEM Attributes

TXP Attributes

Pvt Attributes

Advanced Attributes

NI-RFmx WCDMA

gRPC API Differences From C API

NI RFmx WCDMA C Functions

NI-RFmx GSM

gRPC API Differences From C API

NI RFmx GSM C Functions

NI-RFmx CDMA2k

gRPC API Differences From C API

NI RFmx CDMA2k C Functions

NI-RFmx Instr

General Functions

Configuration Functions

Set And Get Attributes Functions

Utility

Build String

Calibration

Attributes

Advanced Attributes

NI-RFmx LTE

gRPC API Differences From C API

General Functions

Configuration Functions

Ch Configuration Functions

NB IoT Configuration Functions

ModAcc Configuration Functions

ACP Configuration Functions

CHP Configuration Functions

OBW Configuration Functions

SEM Configuration Functions

PVT Configuration Functions

SlotPhase Configuration Functions

SlotPower Configuration Functions

Set And Get Attribute Functions

ModAcc Fetch Functions

ACP Fetch Functions

CHP Fetch Functions

OBW Fetch Functions

SEM Fetch Functions

PVT Fetch Functions

SlotPhase Fetch Functions

SlotPower Fetch Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

Component Carrier Attributes

ModAcc Attributes

ACP Attributes

CHP Attributes

OBW Attributes

SEM Attributes

PVT Attributes

SlotPhase Attributes

SlotPower Attributes

Advanced Attributes

NI-RFmx SpecAn

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Read Functions

Fetch Functions

Utility Functions

Marker Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

ACP Attributes

Cdf Attributes

CHP Attributes

Fcnt Attributes

Harm Attributes

OBW Attributes

SEM Attributes

Spectrum Attributes

Spur Attributes

TXP Attributes

AMPM Attributes

Dpd Attributes

IQ Attributes

IM Attributes

NF Attributes

Phasenoise Attributes

PAVT Attributes

Advanced Attributes

NI-RFmx TD-SCDMA

gRPC API Differences From C API

NI RFmx TD-SCDMA C Functions

NI-RFmx WLAN

gRPC API Differences From C API

General Functions

Configuration Functions

Set And Get Attribute Functions

Fetch DSSS ModAcc Functions

Fetch OFDM ModAcc Functions

Fetch SEM Functions

Fetch TXP Functions

Fetch PowerRamp Functions

Utility Functions

Build String Functions

Advanced Functions

General Attributes

Trigger Attributes

OFDM Attributes

Auto Detect Signal Attributes

DSSS ModAcc Attributes

OFDM ModAcc Attributes

SEM Attributes

TXP Attributes

PowerRamp Attributes

Advanced Attributes

NI-RFSA

General Functions

Configuration Functions

Acquisition Functions

Utility Functions

Calibration Functions

General Attributes

Vertical Attributes

Signal Path Attributes

Acquisition Attributes

Acquisition Attributes

Triggers Attributes

Events Attributes

Device Characteristics Attributes

Peer To Peer Streaming Attributes

Configuration List Attributes

Inherent IVI Properties Attributes

De-embedding Attributes

Self Calibration Attributes

Factory Calibration Attributes

External Alignment Attributes

Device Specific Attributes

NI-RFSG

General Functions

Generation Configuration

Utility Functions

Calibration Functions

Arb Attributes

Clock Attributes

Configuration List Attributes

De-embedding Attributes

Device Characteristics Attributes

Device Specific Attributes

Events Attributes

External Calibration Attributes

Inherent IVI Attributes Attributes

IQ Impairment Attributes

Load Configurations Attributes

Modulation Attributes

Obsolete Attributes

Peer To Peer Attributes

RF Attributes

Self Calibration Attributes

Triggers Attributes

NI-SCOPE

Setup Functions

Configure Functions

Attribute Functions

Acquisition Functions

Measurement Functions

Calibrate Functions

Utility Funcitons

Error Handling Functions

IVI Compliance Or Obsolete Functions

Vertical Attributes

Horizontal Attributes

Trigger Attributes

Clocking Attributes

Synchronization Attributes

Acquisition Attributes

Waveform Measurements Attributes

Onboard Signal Processing Attributes

Peer To Peer Streaming Attributes

Device Attributes

IVI Or Obsolete Attributes

Instrument Capabilities Attributes

If Digitizer Attributes

NI-SWITCH

Setup Functions

Attribute Functions

Route Functions

Scan Functions

Relay Functions

Utility Functions

Value Constants

Channel Configuration Attributes

IVI Attributes

Matrix Configuration Attributes

Module Characteristics Attributes

Scanning Configuration Attributes

NI-TCLK

High-level Functions

Advanced Functions

Attribute Functions

NI-XNET

gRPC API differences from C APIs

General Functions

Cluster Properties

Database Properties

Device Properties

ECU Properties

Frame Properties

Interface Properties

LIN Schedule Entry Properties

LIN Schedule Properties

PDU Properties

Session Ethernet Properties

Session Frame Properties

Session Interface Properties

Session Properties

Session SAE J1939 Properties

Signal Properties

Subframe Properties

System Properties

IP-Stack Functions

Socket Options

Socket Functions