RFmx Demod DotNET

Table of Contents

RFmxDemodMX Methods

  • Updated2024-07-17
  • 12 minute(s) read
RFmxDemodMX Methods

RFmxDemodMX Methods

The RFmxDemodMX type exposes the following members.

Methods

 NameDescription
Public methodAbortMeasurements Stops acquisition as well as the measurements that are associated with the signal instance and that were previously initiated by the Initiate(String, String) method or measurement Read methods.
Public methodAnalyzeIQ1Waveform Performs the enabled measurements on the I/Q complex waveform that you specify in iq parameter. Call this method after you configure the signal and measurement properties. You can fetch measurement results using the Fetch methods. Use this method only if the RFmxInstrMX.SetRecommendedAcquisitionType method is IQ. This method is supported only when the RFmxInstr session is created with option string "AnalysisOnly=1".
Note  Note
Query the RFmxInstrMXRecommendedAcquisitionType property after calling the Commit(String) method.
Public methodAutoLevel Examines the incoming signal to calculate the peak power level and sets the power level based on the value of the reference level. Use this method to help calculate an approximate setting for the power level for measurements.
Public methodStatic memberBuildResultString Creates the selector string for use with Configuration or Fetch methods.
Public methodCheckMeasurementStatus Checks the measurement status for demodulated measurements.
Public methodClearAllNamedResults Clears all results for the current signal instance.
Public methodClearNamedResult Clears a result instance specified by the result name in the selectorString parameter.
Public methodCloneSignalConfiguration Creates a new instance of a signal by copying all the values from an existing signal instance.
Public methodCommit Commits settings to the hardware. Calling this method is optional. RFmxDemod commits settings to the hardware when you call the RFmxInstr Initiate method or any of the measurement Read methods.
Public methodConfigureDigitalEdgeTrigger Configures the digital-edge trigger.
Public methodConfigureExternalAttenuation Configures the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer.
Public methodConfigureFrequency Configures the expected carrier frequency of the RF signal that needs to be acquired. The signal analyzer tunes to this frequency.
Public methodConfigureIQPowerEdgeTrigger Configures the I/Q power-edge trigger.
Public methodConfigureReferenceLevel Configures the reference level that represents the maximum expected power of an RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodConfigureRF Configures the RF properties of the signal by specifying the selector string.
Public methodConfigureSoftwareEdgeTrigger Configures the software-edge trigger.
Public methodDeleteSignalConfiguration Deletes the current instance of the signal.
Public methodDisableTrigger Disables the trigger.
Public methodDispose Deletes the signal configuration if it is not the default configuration and clears any trace of the current signal configuration, if any.
Public methodEqualsDetermines whether the specified Object is equal to the current Object.
(Inherited from Object)
Public methodGetAllNamedResultNames Returns all the named result names of the current signal instance.
Public methodGetAttributeBool Gets the value of a Boolean attribute.
Public methodGetAttributeDouble Gets the value of a double attribute.
Public methodGetAttributeInt Gets the value of an integer attribute.
Public methodGetAttributeSByteArray Gets the value of a signed byte array attribute.
Public methodGetAttributeString Gets the value of a string attribute.
Public methodGetAutoLevelInitialReferenceLevel Gets the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodGetCenterFrequency Gets the carrier frequency, in hertz (Hz), of the RF signal to acquire. The signal analyzer tunes to this frequency.
Public methodGetDigitalEdgeTriggerEdge Gets a value that indicates whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal.
Public methodGetDigitalEdgeTriggerSource Gets the value that indicates the source terminal for the digital-edge trigger.
Public methodGetErrorString Gets the error description that specifies the origin/reason of the error or warning.
Public methodGetExternalAttenuation Gets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer.
Public methodGetHashCodeServes as a hash function for a particular type.
(Inherited from Object)
Public methodGetIQPowerEdgeTriggerLevel Gets the power level at which the device triggers. This value is expressed in dB when you set the GetIQPowerEdgeTriggerLevelType(String, RFmxDemodMXIQPowerEdgeTriggerLevelType) to Relative and in dBm when you set the GetIQPowerEdgeTriggerLevelType(String, RFmxDemodMXIQPowerEdgeTriggerLevelType) method to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. This method is used only when you set the GetTriggerType(String, RFmxDemodMXTriggerType) method to IQ Power Edge.
Public methodGetIQPowerEdgeTriggerLevelType Gets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxDemodMXTriggerType) method to IQPowerEdge.
Public methodGetIQPowerEdgeTriggerSlope Gets the value that indicates whether the device asserts the trigger when the signal power is rising or falling.
Public methodGetIQPowerEdgeTriggerSource Gets the channel from which the device monitors the trigger.
Public methodGetLimitedConfigurationChange Gets the set of properties that are considered by RFmx in the locked signal configuration state.
Public methodGetReferenceLevel Gets the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodGetReferenceLevelHeadroom Gets the margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the reference level plus the reference level headroom. If you know the input power of the signal precisely or previously included the margin in the reference level, you could improve the signal-to-noise ratio by reducing the reference level headroom.

Default values

PXIe-5668: 6 dB

PXIe-5830/5831/5832/5841/5842/5860: 1 dB

PXIe-5840: 0 dB

Supported devices: PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.

Public methodGetResultFetchTimeout Gets the time, in seconds, for which the measurement waits for fetching results.
Public methodGetSelectedPorts Gets the instrument port to be configured to acquire a signal.

Valid values

PXIe-5820/5840: "" (empty string)

PXIe-5830: if0, if1

PXIe-5831/5832: if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel

Default values

PXIe-5820/5840: "" (empty string)

PXIe-5830/5831/5832: if1

PXIe-5831/5832: if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel

Supported devices: PXIe-5820/5830/5831/5832/5840

Public methodGetTriggerDelay Gets the trigger delay time, in seconds.
Public methodGetTriggerMinimumQuietTimeDuration Gets the time duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q power-edge trigger.
Public methodGetTriggerMinimumQuietTimeMode Gets a value that indicates whether the measurement computes the minimum quiet time used for triggering.
Public methodGetTriggerType Gets the type of reference trigger to use for signal acquisition.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetWarning Retrieves and then clears the warning information for the session.
Public methodInitiate Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. To get the status of measurements, you can use the CheckMeasurementStatus(String, Boolean) method.
Public methodResetAttribute Resets the attribute to its default value.
Public methodResetToDefault Resets a signal to the default values.
Public methodSelectMeasurements Enables the measurement that you specify in the measurements parameter and disables all other measurements.
Public methodSendSoftwareEdgeTrigger Sends a trigger to the device when you use the ConfigureSoftwareEdgeTrigger(String, Double, Boolean) to choose a software version of a trigger, and the device is waiting for the trigger to be sent. You can also use this method to override a hardware trigger.
Public methodSetAttributeBool Sets the value of a Boolean attribute.
Public methodSetAttributeDouble Sets the value of a double attribute.
Public methodSetAttributeInt Sets the value of an integer attribute.
Public methodSetAttributeSByteArray Set the value of a signed byte array attribute.
Public methodSetAttributeString Sets the value of a string attribute.
Public methodSetAutoLevelInitialReferenceLevel Sets the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodSetCenterFrequency Sets the carrier frequency, in hertz (Hz), of the RF signal to acquire. The signal analyzer tunes to this frequency.
Public methodSetDigitalEdgeTriggerEdge Sets the signal analyzer to detect a rising or falling edge on the digital-edge trigger signal.
Public methodSetDigitalEdgeTriggerSource Sets the source terminal for the digital-edge trigger.
Public methodSetExternalAttenuation Sets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer.
Public methodSetIQPowerEdgeTriggerLevel Sets the power level at which the device triggers. This value is expressed in dB when you set the GetIQPowerEdgeTriggerLevelType(String, RFmxDemodMXIQPowerEdgeTriggerLevelType) to Relative and in dBm when you set the GetIQPowerEdgeTriggerLevelType(String, RFmxDemodMXIQPowerEdgeTriggerLevelType) method to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. This method is used only when you set the GetTriggerType(String, RFmxDemodMXTriggerType) method to IQ Power Edge.
Public methodSetIQPowerEdgeTriggerLevelType Sets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxDemodMXTriggerType) method to IQPowerEdge.
Public methodSetIQPowerEdgeTriggerSlope Sets whether the device asserts the trigger when the signal power is rising or falling.
Public methodSetIQPowerEdgeTriggerSource Sets the channel from which the device monitors the trigger.
Public methodSetLimitedConfigurationChange Sets the set of properties that are considered by RFmx in the locked signal configuration state.
Public methodSetReferenceLevel Sets the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodSetReferenceLevelHeadroom Sets the margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the reference level plus the reference level headroom. If you know the input power of the signal precisely or previously included the margin in the reference level, you could improve the signal-to-noise ratio by reducing the reference level headroom.

Default values

PXIe-5668: 6 dB

PXIe-5830/5831/5832/5841/5842/5860: 1 dB

PXIe-5840: 0 dB

Supported devices: PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.

Public methodSetResultFetchTimeout Sets the time, in seconds, for which the measurement waits for fetching results. Set this value to a time longer than expected for fetching the measurement.
Public methodSetSelectedPorts Sets the instrument port to be configured to acquire a signal.

Valid values

PXIe-5820/5840: "" (empty string)

PXIe-5830: if0, if1

PXIe-5831/5832: if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel

Default values

PXIe-5820/5840: "" (empty string)

PXIe-5830/5831/5832: if1

PXIe-5831/5832: if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel

Supported devices: PXIe-5820/5830/5831/5832/5840

Public methodSetTriggerDelay Sets the trigger delay time, in seconds.
Public methodSetTriggerMinimumQuietTimeDuration Sets the time duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q power-edge trigger.
Public methodSetTriggerMinimumQuietTimeMode Sets whether the measurement computes the minimum quiet time used for triggering.
Public methodSetTriggerType Sets the type of reference trigger to use for signal acquisition.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWaitForMeasurementComplete Waits for the number for seconds specified using the timeout parameter for all measurements to complete.
Top

See Also

Log in to get a better experience