RFmxTdscdmaMXCdaResults.FetchCodeDomainPower Method
- Updated2024-07-17
- 3 minute(s) read
RFmxTdscdmaMXCdaResultsFetchCodeDomainPower Method
Fetches the scalar code domain measurement results.
Namespace: NationalInstruments.RFmx.TdscdmaMX
Assembly: NationalInstruments.RFmx.TdscdmaMX.Fx40 (in NationalInstruments.RFmx.TdscdmaMX.Fx40.dll) Version: 24.5.0.49284 (24.5.0.49284)
Syntax
public int FetchCodeDomainPower( string selectorString, double timeout, out double meanTotalPower, out double meanTotalActivePower, out double meanActivePower, out double maximumPeakActivePower, out double meanInactivePower, out double maximumPeakInactivePower )
Public Function FetchCodeDomainPower ( selectorString As String, timeout As Double, <OutAttribute> ByRef meanTotalPower As Double, <OutAttribute> ByRef meanTotalActivePower As Double, <OutAttribute> ByRef meanActivePower As Double, <OutAttribute> ByRef maximumPeakActivePower As Double, <OutAttribute> ByRef meanInactivePower As Double, <OutAttribute> ByRef maximumPeakInactivePower As Double ) As Integer
Parameters
- selectorString
- Type: SystemString
Specifies a selector string comprising of the result name. If you do not specify the result name, the default result instance is used. - timeout
- Type: SystemDouble
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 method waits until the measurement is complete. - meanTotalPower
- Type: SystemDouble
Upon return, contains the total power measured in the code domain of the base spreading factor, averaged over all averaging iterations. This value is expressed in dBm. - meanTotalActivePower
- Type: SystemDouble
Upon return, contains the total active code power measured in the code domain of the base spreading factor, normalized to the total code domain power (CDP). This value is expressed in dB, if you set the SetPowerUnit(String, RFmxTdscdmaMXCdaPowerUnit) method to dB, or in dBm, if you set the CDA Pwr Unit method to dBm. - meanActivePower
- Type: SystemDouble
Upon return, contains the average of the active code power measured in the code domain of the base spreading factor, normalized to the total CDP. This value is expressed in dB, if you set the CDA Pwr Unit method to dB, or in dBm, if you set the CDA Pwr Unit method to dBm. - maximumPeakActivePower
- Type: SystemDouble
Upon return, contains the maximum value among all averaging iterations of the maximum active code power measured in the code domain of the base spreading factor, normalized to the total CDP. This value is expressed in dB, if you set the CDA Pwr Unit method to dB, or in dBm, if you set the CDA Pwr Unit method to dBm. - meanInactivePower
- Type: SystemDouble
Upon return, contains the average of the code power measured among the set of inactive channels in the code domain of the base spreading factor, normalized to the total CDP. This value is expressed in dB, if you set the CDA Pwr Unit method to dB, or in dBm, if you set the CDA Pwr Unit method to dBm. - maximumPeakInactivePower
- Type: SystemDouble
Upon return, contains the maximum value among all averaging iterations of the highest measured code power among the set of inactive channels in the code domain of the base spreading factor, normalized to the total CDP. This value is expressed in dB, if you set the CDA Pwr Unit method to dB, or in dBm, if you set the CDA Pwr Unit method to dBm.
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.