RFmxPulseMX.GetReferenceLevelHeadroom Method
- Updated2024-07-17
- 1 minute(s) read
RFmxPulseMXGetReferenceLevelHeadroom Method
Gets the margin RFmx adds to the ReferenceLevel method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
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 GetReferenceLevelHeadroom( string selectorString, out double value )
Public Function GetReferenceLevelHeadroom ( selectorString As String, <OutAttribute> ByRef value As Double ) As Integer
Parameters
- selectorString
- Type: SystemString
Pass an empty string. The signal name that is passed when creating the signal configuration is used. - value
- Type: SystemDouble
Upon return, contains the margin RFmx adds to the ReferenceLevel method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
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 ReferenceLevelHeadroom attribute.Default values PXIe-5668: 6 dB, PXIe-5830/5831/5832/5841/5842/5860: 1 dB, PXIe-5840: 0 dB