RFmxWcdmaMXModAccResults.FetchPeakCde(String, Double, Double, Int32, RFmxWcdmaMXModAccPeakCdeBranch) Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Fetches the peak value among the code domain errors (CDEs) obtained with a fixed spreading factor of 4, along with the code number and branch that correspond to this peak value for a carrier in the ModAcc measurement.
Use "carrier(n)" as the selector string to read results from this method.
Use "carrier(n)" as the selector string to read results from this method.
Namespace: NationalInstruments.RFmx.WcdmaMX
Assembly: NationalInstruments.RFmx.WcdmaMX.Fx40 (in NationalInstruments.RFmx.WcdmaMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int FetchPeakCde( string selectorString, double timeout, out double peakCde, out int peakCdeCode, out RFmxWcdmaMXModAccPeakCdeBranch peakCdeBranch )
Public Function FetchPeakCde ( selectorString As String, timeout As Double, <OutAttribute> ByRef peakCde As Double, <OutAttribute> ByRef peakCdeCode As Integer, <OutAttribute> ByRef peakCdeBranch As RFmxWcdmaMXModAccPeakCdeBranch ) As Integer
Parameters
- selectorString String
-
Specifies a selector string comprising of the result name, and carrier number. If you do not specify the result name, the default result instance is used.
Example:
"carrier0"
"result::r1/carrier0"
You can use the BuildCarrierString(String, Int32) method to build the selector string. - timeout Double
- Specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete.
- peakCde Double
-
Upon return, contains the maximum CDE value for a carrier in the received signal.
- peakCdeCode Int32
-
Upon return, contains the spreading code corresponding to the value of the peakCDE parameter for a carrier in the received signal.
- peakCdeBranch RFmxWcdmaMXModAccPeakCdeBranch
-
Upon return, contains the branch of the channel corresponding to the value of the peakCDE parameter for a carrier in the received signal.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.