FetchCarrierMeasurement(string, double, out double, out double, out double, out double)
- Updated2025-10-13
- 1 minute(s) read
Fetches the carrier power measurement.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int FetchCarrierMeasurement(string selectorString, double timeout, out double absolutePower, out double peakAbsolutePower, out double peakFrequency, out double totalRelativePower)
Remarks
This method maps to the RFmxSpecAn_SEMFetchCarrierMeasurement() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies the result name and carrier number. Example: "carrier0", "result::r1/carrier0". You can use the BuildCarrierString2(string, int) 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 | out 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 | out 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 | out double | Upon return, contains the frequency, in hertz (Hz), at which the peak power occurs in the carrier channel. |
| totalRelativePower | out double | Upon return, contains the carrier power, in dB, relative to the total carrier power of all enabled carriers. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.