RFmxSpecAnMXNFResults.FetchYFactorPowers Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Fetches the hot and cold powers measured when the Y-Factor based noise figure (NF) measurement is performed.
Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int FetchYFactorPowers( string selectorString, double timeout, ref double[] hotPower, ref double[] coldPower )
Public Function FetchYFactorPowers ( selectorString As String, timeout As Double, ByRef hotPower As Double(), ByRef coldPower As Double() ) As Integer
Parameters
- selectorString String
-
Specifies a selector string comprising of the result name. If you do not specify the result name, the default result instance is used.
Example:
""
""
"result::r1"
You can use the BuildResultString(String) method to build the selector string. - timeout Double
- Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete.
- hotPower Double
-
Upon return, contains an array of powers measured at the frequencies specified by the SetFrequencyList(String, Double) method, when the noise source is enabled. This value is expressed in dBm. A valid result is returned only when you set the SetMeasurementMethod(String, RFmxSpecAnMXNFMeasurementMethod) method to YFactor.
- coldPower Double
-
Upon return, contains an array of powers measured at the frequencies specified by the SetFrequencyList(String, Double) method, when the noise source is disabled. This value is expressed in dBm. A valid result is returned only when you set the SetMeasurementMethod(String, RFmxSpecAnMXNFMeasurementMethod) method to YFactor.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.