RFmxSpecAnMXPavtResults.FetchPhaseTrace Method
- Updated2024-07-17
- 1 minute(s) read
RFmx
Fetches the phase trace for the measurement.
Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int FetchPhaseTrace( string selectorString, double timeout, int traceIndex, ref AnalogWaveform<float> phase )
Public Function FetchPhaseTrace ( selectorString As String, timeout As Double, traceIndex As Integer, ByRef phase As AnalogWaveform(Of Single) ) As Integer
Parameters
- selectorString String
-
Specifies a selector string comprising of the result name. If you do not specify the result name, the default result instance is used.
Example:
""
""
"result::r1"
You can use the BuildResultString(String) method to build the selector string. - timeout Double
- Specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete.
- traceIndex Int32
- Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets).
- phase AnalogWaveformSingle
-
Upon return, contains the phase trace for the measurement specified by the traceIndex parameter.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.