RFmxSpecAnMXSemResults.FetchCarrierMeasurement Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Fetches the carrier power measurement.
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 FetchCarrierMeasurement( string selectorString, double timeout, out double absolutePower, out double peakAbsolutePower, out double peakFrequency, out double totalRelativePower )
Public Function FetchCarrierMeasurement ( selectorString As String, timeout As Double, <OutAttribute> ByRef absolutePower As Double, <OutAttribute> ByRef peakAbsolutePower As Double, <OutAttribute> ByRef peakFrequency As Double, <OutAttribute> ByRef totalRelativePower As Double ) As Integer
Parameters
- selectorString String
- Specifies the result name and carrier number. Example: "carrier0", "result::r1/carrier0". You can use the BuildCarrierString2(String, Int32) 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.
- absolutePower Double
- Upon return, contains the carrier power. The power is measured in dBm when you set the RFmxSpecAnMXSemPowerUnits method to dBm, and in dBm/Hz when you set the RFmxSpecAnMXSemPowerUnits method to dBmPerHertz.
- peakAbsolutePower Double
- Upon return, contains the peak power in the carrier channel. The power is measured in dBm when you set the RFmxSpecAnMXSemPowerUnits method to dBm, and in dBm/Hz when you set the RFmxSpecAnMXSemPowerUnits method to dBmPerHertz.
- peakFrequency Double
- Upon return, contains the frequency, in hertz (Hz), at which the peak power occurs in the carrier channel.
- totalRelativePower Double
- Upon return, contains the carrier power, in dB, relative to the total carrier power of all enabled carriers.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes an error or warning condition.
Remarks
This method maps to the RFmxSpecAn_SEMFetchCarrierMeasurement() function in C.