Gets the maximum of ripple values computed for all measured pulses. This value is expressed in units specified by SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) method.

Syntax

Namespace: NationalInstruments.RFmx.PulseMX

public int GetRippleMaximum(string selectorString, out double value)

Remarks

This method gets the value of PulseResultsRippleMaximum attribute.

Parameters

NameTypeDescription
selectorStringstring

Specifies the result name.
Example: ""
"result::r1"
You can use the BuildResultString(string) method to build the selectorString.

valueout double

Upon return, contains the maximum of ripple values computed for all measured pulses. This value is expressed in units specified by SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) method.

Returns

Returns the status code of this method. The status code either indicates success or describes a warning condition.