Fetches the mean values of phase and amplitude of the segment. Use "segment<n>" as the selector string to read results from this function.

Syntax

int32 __stdcall RFmxSpecAn_PAVTFetchPhaseAndAmplitude(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *meanRelativePhase, float64 *meanRelativeAmplitude, float64 *meanAbsolutePhase, float64 *meanAbsoluteAmplitude)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char

This parameter specifies a Selector String comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. The default value is "segment0".
Example:
"segment0"
"signal::sig1/segment0"
"result::r1/segment0"
"signal::sig1/result::r1/segment0"
You can use the RFmxSpecAn_BuildSegmentString function to build the selector string.

timeout[in]float64

This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. The default value is 10.

meanRelativePhase[out]float64 *

This parameter returns the mean phase of the segment, relative to the phase of the reference segment. This value is expressed in degrees.

meanRelativeAmplitude[out]float64 *

This parameter returns the mean amplitude of the segment, relative to the amplitude of the reference segment. This value is expressed in dB.

meanAbsolutePhase[out]float64 *

This parameter returns the mean absolute phase of the segment. This value is expressed in degrees.

meanAbsoluteAmplitude[out]float64 *

This parameter returns the mean absolute amplitude of the segment. This value is expressed in dBm.

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

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors