RFmxVnaMX.GetSegmentDwellTime Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Gets the dwell time for the selected segment when Segment Dwell Time Enabled method is set to True. This is the time for which the analyzer waits before acquiring the signal for each measured frequency point of the segment. Use dwell time when measuring devices with substantial electrical lengths, requiring compensation for the delay between frequency changes at the generator and their observation at the analyzer. This value is expressed in seconds.
Namespace: NationalInstruments.RFmx.VnaMX
Assembly: NationalInstruments.RFmx.VnaMX.Fx40 (in NationalInstruments.RFmx.VnaMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int GetSegmentDwellTime( string selectorString, out double value )
Public Function GetSegmentDwellTime ( selectorString As String, <OutAttribute> ByRef value As Double ) As Integer
Parameters
- selectorString String
- Specifies the segment number and signal number.
Example:
"signal0" or
"signal0/segment0".
You can use the BuildSegmentString(String, Int32) method to build the selector string. - value Double
- Upon return, contains the dwell time for the selected segment when Segment Dwell Time Enabled method is set to True. This is the time for which the analyzer waits before acquiring the signal for each measured frequency point of the segment. Use dwell time when measuring devices with substantial electrical lengths, requiring compensation for the delay between frequency changes at the generator and their observation at the analyzer. This value is expressed in seconds.
Return Value
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 SegmentDwellTime attribute.The default value is 0.