RFmxPulseMXPulseResults.GetOvershoot Method
- Updated2024-07-17
- 1 minute(s) read
RFmxPulseMXPulseResultsGetOvershoot Method
Gets the overshoot values computed for all measured pulses. The overshoot value is defined as the ratio of height of the local peak after a rising edge to the pulse amplitude. 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 GetOvershoot( string selectorString, ref double[] value )
Public Function GetOvershoot ( 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 overshoot values computed for all measured pulses. The overshoot value is defined as the ratio of height of the local peak after a rising edge to the pulse amplitude. 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 PulseResultsOvershoot attribute.