RFmxLteMXModAccResults.FetchCompositeMagnitudeAndPhaseError Method
- Updated2024-07-17
- 2 minute(s) read
RFmxLteMXModAccResultsFetchCompositeMagnitudeAndPhaseError Method
Returns the mean RMS composite magnitude error, phase error, the maximum peak composite magnitude error, and the phase error.
The method result is valid only when you set the SetLinkDirection(String, RFmxLteMXLinkDirection) method to Uplink.
Use "carrier(k)" or "subblock(n)/carrier(k)" as the selector string to read results from this method.
The method result is valid only when you set the SetLinkDirection(String, RFmxLteMXLinkDirection) method to Uplink.
Use "carrier(k)" or "subblock(n)/carrier(k)" as the selector string to read results from this method.
Namespace: NationalInstruments.RFmx.LteMX
Assembly: NationalInstruments.RFmx.LteMX.Fx40 (in NationalInstruments.RFmx.LteMX.Fx40.dll) Version: 24.5.0.49283 (24.5.0.49283)
Syntax
public int FetchCompositeMagnitudeAndPhaseError( string selectorString, double timeout, out double meanRmsCompositeMagnitudeError, out double maximumPeakCompositeMagnitudeError, out double meanRmsCompositePhaseError, out double maximumPeakCompositePhaseError )
Public Function FetchCompositeMagnitudeAndPhaseError ( selectorString As String, timeout As Double, <OutAttribute> ByRef meanRmsCompositeMagnitudeError As Double, <OutAttribute> ByRef maximumPeakCompositeMagnitudeError As Double, <OutAttribute> ByRef meanRmsCompositePhaseError As Double, <OutAttribute> ByRef maximumPeakCompositePhaseError As Double ) As Integer
Parameters
- selectorString
- Type: SystemString
Specifies a selector string comprising of the result name, subblock number, and carrier number. If you do not specify the result name, the default result instance is used. Example:
"subblock0/carrier0"
"result::r1/subblock0/carrier0"
You can use the BuildCarrierString(String, Int32) method to build the selector string. - 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. - meanRmsCompositeMagnitudeError
- Type: SystemDouble
Upon return, contains the RMS mean value of the magnitude error calculated over the slots specified by the SetMeasurementLength(String, Int32) method on all the configured channels. - maximumPeakCompositeMagnitudeError
- Type: SystemDouble
Upon return, contains the peak value of magnitude error calculated over the slots specified by the ModAcc Meas Length method on all the configured channels. - meanRmsCompositePhaseError
- Type: SystemDouble
Upon return, contains the RMS mean value of the phase error calculated over the slots specified by the ModAcc Meas Length method on all the configured channels. This value is expressed in degrees. - maximumPeakCompositePhaseError
- Type: SystemDouble
Upon return, contains the peak value of phase error calculated over the slots specified by the ModAcc Meas Length method on all thee configured channels. This value is expressed in degrees.
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.