Configures the time required for the acquisition to wait till the noise source used in the Y-Factor method settles to hot or cold state when the noise source is powered on or off.

Syntax

int32 __stdcall RFmxSpecAn_NFCfgYFactorNoiseSourceSettlingTime(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 settlingTime)

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. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string).
Example:
""
"signal::sig1"
You can use the RFmxSpecAn_BuildSignalString function to build the selector string.

settlingTime[in]float64

This parameter specifies the time to wait till the noise source used in the Y-Factor method settles to either hot or cold state when the noise source is enabled or disabled. This attribute is used only when you set the RFMXSPECAN_ATTR_NF_Y_FACTOR_NOISE_SOURCE_TYPE attribute to External Noise Source. This value is expressed in seconds. The default value is 0.

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