RFmxPulseMXPulseResults.GetRipple Method
- Updated2024-07-17
- 1 minute(s) read
RFmxPulseMXPulseResultsGetRipple Method
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.
Namespace: NationalInstruments.RFmx.PulseMX
Assembly: NationalInstruments.RFmx.PulseMX.Fx40 (in NationalInstruments.RFmx.PulseMX.Fx40.dll) Version: 24.5.0.49283 (24.5.0.49283)
Syntax
public int GetRipple( string selectorString, ref double[] value )
Public Function GetRipple ( selectorString As String, ByRef value As Double() ) As Integer
Parameters
- selectorString
- Type: SystemString
Specifies the result name.
Example: ""
"result::r1"
You can use the BuildResultString(String) method to build the selectorString. - value
- Type: SystemDouble
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.
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method gets the value of PulseResultsRipple attribute.