Stores the external attenuation table in the calibration plane specified by the Selector String parameter. On a MIMO session, the external attenuation table is stored for each MIMO port in the specified calibration plane.

Syntax

int32 __stdcall RFmxInstr_CfgExternalAttenuationTable(niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName, float64 frequency[], float64 externalAttenuation[], int32 arraySize)

Remarks

If there is only one table configured in any calibration plane, it is automatically selected as the active table.

Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

selectorString[in]char[]

This parameter specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. The default value is "" (empty string).

On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure external attenuation table for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".

Note

For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::<calplaneName>/port::<portName>". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::<calplaneName>/port::<deviceName>/<channelNumber>/<portName>". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.

Example:

""

"calplane::plane0"

"calplane::plane0/port::if0"

"port::if0"

"calplane::plane0/port::all"

"calplane::plane0/port::myrfsa1/0"

"calplane::plane0/port::myrfsa1/0, port::myrfsa2/0"

"calplane::plane0/port::myrfsa1/0/if0"

tableName[in]char

This parameter specifies the name to be associated with external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table. The default value is "" (empty string).

Example:

""

"table1"

frequency[in]float64[]

This parameter specifies an array of frequencies in the external attenuation table. This value is expressed in Hz.

externalAttenuation[in]float64[]

This parameter specifies an array of attenuations corresponding to the frequency specified by the Frequency parameter. This value is expressed in dB.

arraySize[in]int32

Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.

Returns

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

To obtain a text description of the status code and additional information about the error condition, call the RFmxInstr_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors