Gets the ripple values computed for all measured pulses. Ripple values are the difference between the maximum and minimum deviation from the pulse top reference. This value is expressed in units specified by SetMetricsAmplitudeDeviationUnit(string, RFmxPulseMXPulseMetricsAmplitudeDeviationUnit) method.

Syntax

Namespace: NationalInstruments.RFmx.PulseMX

public int GetRipple(string selectorString, ref double[] value)

Remarks

This method gets the value of PulseResultsRipple attribute.

Parameters

NameTypeDescription
selectorStringstring

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

valueref double[]

Upon return, contains the ripple values computed for all measured pulses. Ripple values are the difference between the maximum and minimum deviation from the pulse top reference. 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.