RFmxPulseMXPulseResults.GetDroop Method
- Updated2024-07-17
- 1 minute(s) read
RFmxPulseMXPulseResultsGetDroop Method
Gets the droop values computed for all measured pulses. Droop values are defined as the rate at which the pulse top levels decays from the beginning to the end during On duration. 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 GetDroop( string selectorString, ref double[] value )
Public Function GetDroop ( 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 droop values computed for all measured pulses. Droop values are defined as the rate at which the pulse top levels decays from the beginning to the end during On duration. 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 PulseResultsDroop attribute.