RFmxDemodMX Class
- Updated2025-04-08
- 8 minute(s) read
Defines a root class that is used to identify and control demod signal configuration.
Derives from
- ISignalConfiguration
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.DemodMX
public class RFmxDemodMX : ISignalConfiguration, IDisposable
Remarks
To create a demod signal configuration, instantiate a RFmxInstrMX instance and invoke GetDemodSignalConfiguration, which returns a demod signal configuration.
Thread Safety
Any public static members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Properties
| Name | Description |
|---|---|
| ADemod | Gets the RFmxDemodMXADemod instance that represents the analog demodulation measurement. |
| DDemod | Gets the RFmxDemodMXDDemod instance that represents the digital demodulation measurement. |
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| SignalConfigurationName | Returns current signal configuration name. |
| SignalConfigurationType | Returns System.Type object for RFmxDemodMX. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | 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. |
| AnalyzeIQ1Waveform(string, string, ComplexWaveform< ComplexSingle >, bool, long) | 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 Query the RFmxInstrMXRecommendedAcquisitionType property after calling the Commit(string) method. |
| AutoLevel(string, double, double, out double) | 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. |
| CheckMeasurementStatus(string, out bool) | Checks the measurement status for demodulated measurements. |
| ClearAllNamedResults(string) | Clears all results for the current signal instance. |
| ClearNamedResult(string) | Clears a result instance specified by the result name in the selectorString parameter. |
| CloneSignalConfiguration(string, out RFmxDemodMX) | Creates a new instance of a signal by copying all the values from an existing signal instance. |
| Commit(string) | 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. |
| ConfigureDigitalEdgeTrigger(string, string, RFmxDemodMXDigitalEdgeTriggerEdge, double, bool) | Configures the digital-edge trigger. |
| ConfigureExternalAttenuation(string, double) | Configures the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. |
| ConfigureFrequency(string, double) | Configures the expected carrier frequency of the RF signal that needs to be acquired. The signal analyzer tunes to this frequency. |
| ConfigureIQPowerEdgeTrigger(string, string, double, RFmxDemodMXIQPowerEdgeTriggerSlope, double, RFmxDemodMXTriggerMinimumQuietTimeMode, double, bool) | Configures the I/Q power-edge trigger. |
| ConfigureReferenceLevel(string, double) | 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. |
| ConfigureRF(string, double, double, double) | Configures the RF properties of the signal by specifying the selector string. |
| ConfigureSoftwareEdgeTrigger(string, double, bool) | Configures the software-edge trigger. |
| DeleteSignalConfiguration() | Deletes the current instance of the signal. |
| DisableTrigger(string) | Disables the trigger. |
| Dispose() | Deletes the signal configuration if it is not the default configuration and clears any trace of the current signal configuration, if any. |
| GetAllNamedResultNames(string, out string[], out bool) | Returns all the named result names of the current signal instance. |
| GetAttributeBool(string, int, out bool) | Gets the value of a Boolean attribute. |
| GetAttributeDouble(string, int, out double) | Gets the value of a double attribute. |
| GetAttributeInt(string, int, out int) | Gets the value of an integer attribute. |
| GetAttributeSByteArray(string, int, ref sbyte[]) | Gets the value of a signed byte array attribute. |
| GetAttributeString(string, int, out string) | Gets the value of a string attribute. |
| GetAutoLevelInitialReferenceLevel(string, out double) | 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. |
| GetCenterFrequency(string, out double) | Gets the carrier frequency, in hertz (Hz), of the RF signal to acquire. The signal analyzer tunes to this frequency. |
| GetDigitalEdgeTriggerEdge(string, out RFmxDemodMXDigitalEdgeTriggerEdge) | Gets a value that indicates whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. |
| GetDigitalEdgeTriggerSource(string, out string) | Gets the value that indicates the source terminal for the digital-edge trigger. |
| GetErrorString(int, out string) | Gets the error description that specifies the origin/reason of the error or warning. |
| GetExternalAttenuation(string, out double) | Gets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. |
| GetIQPowerEdgeTriggerLevel(string, out double) | Gets the power level at which the device triggers. This value is expressed in dB when you set the NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetIQPowerEdgeTriggerLevelType(string,NationalInstruments.RFmx.DemodMX.RFmxDemodMXIQPowerEdgeTriggerLevelType@) to Relative and in dBm when you set the NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetIQPowerEdgeTriggerLevelType(string,NationalInstruments.RFmx.DemodMX.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 NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetTriggerType(string,NationalInstruments.RFmx.DemodMX.RFmxDemodMXTriggerType@) method to IQ Power Edge. |
| GetIQPowerEdgeTriggerLevelType(string, out RFmxDemodMXIQPowerEdgeTriggerLevelType) | Gets the reference for the SetIQPowerEdgeTriggerLevel(string, double) method. This method is used only when you set the SetTriggerType(string, RFmxDemodMXTriggerType) method to IQPowerEdge. |
| GetIQPowerEdgeTriggerSlope(string, out RFmxDemodMXIQPowerEdgeTriggerSlope) | Gets the value that indicates whether the device asserts the trigger when the signal power is rising or falling. |
| GetIQPowerEdgeTriggerSource(string, out string) | Gets the channel from which the device monitors the trigger. |
| GetLimitedConfigurationChange(string, out RFmxDemodMXLimitedConfigurationChange) | Gets the set of properties that are considered by RFmx in the locked signal configuration state. |
| GetReferenceLevel(string, out double) | 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. |
| GetReferenceLevelHeadroom(string, out double) | 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 |
| GetResultFetchTimeout(string, out double) | Gets the time, in seconds, for which the measurement waits for fetching results. |
| GetSelectedPorts(string, out string) | Gets the instrument port to be configured to acquire a signal. Valid values |
| GetTriggerDelay(string, out double) | Gets the trigger delay time, in seconds. |
| GetTriggerMinimumQuietTimeDuration(string, out double) | Gets the time duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q power-edge trigger. |
| GetTriggerMinimumQuietTimeMode(string, out RFmxDemodMXTriggerMinimumQuietTimeMode) | Gets a value that indicates whether the measurement computes the minimum quiet time used for triggering. |
| GetTriggerType(string, out RFmxDemodMXTriggerType) | Gets the type of reference trigger to use for signal acquisition. |
| GetWarning(out int, out string) | Retrieves and then clears the warning information for the session. |
| Initiate(string, string) | 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, out bool) method. |
| ResetAttribute(string, RFmxDemodMXPropertyId) | Resets the attribute to its default value. |
| ResetToDefault(string) | Resets a signal to the default values. |
| SelectMeasurements(string, RFmxDemodMXMeasurementTypes, bool) | Enables the measurement that you specify in the measurements parameter and disables all other measurements. |
| SendSoftwareEdgeTrigger() | Sends a trigger to the device when you use the ConfigureSoftwareEdgeTrigger(string, double, bool) 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. |
| SetAttributeBool(string, int, bool) | Sets the value of a Boolean attribute. |
| SetAttributeDouble(string, int, double) | Sets the value of a double attribute. |
| SetAttributeInt(string, int, int) | Sets the value of an integer attribute. |
| SetAttributeSByteArray(string, int, sbyte[]) | Set the value of a signed byte array attribute. |
| SetAttributeString(string, int, string) | Sets the value of a string attribute. |
| SetAutoLevelInitialReferenceLevel(string, double) | 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. |
| SetCenterFrequency(string, double) | Sets the carrier frequency, in hertz (Hz), of the RF signal to acquire. The signal analyzer tunes to this frequency. |
| SetDigitalEdgeTriggerEdge(string, RFmxDemodMXDigitalEdgeTriggerEdge) | Sets the signal analyzer to detect a rising or falling edge on the digital-edge trigger signal. |
| SetDigitalEdgeTriggerSource(string, string) | Sets the source terminal for the digital-edge trigger. |
| SetExternalAttenuation(string, double) | Sets the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. |
| SetIQPowerEdgeTriggerLevel(string, double) | Sets the power level at which the device triggers. This value is expressed in dB when you set the NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetIQPowerEdgeTriggerLevelType(string,NationalInstruments.RFmx.DemodMX.RFmxDemodMXIQPowerEdgeTriggerLevelType@) to Relative and in dBm when you set the NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetIQPowerEdgeTriggerLevelType(string,NationalInstruments.RFmx.DemodMX.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 NationalInstruments.RFmx.DemodMX.RFmxDemodMX.GetTriggerType(string,NationalInstruments.RFmx.DemodMX.RFmxDemodMXTriggerType@) method to IQ Power Edge. |
| SetIQPowerEdgeTriggerLevelType(string, RFmxDemodMXIQPowerEdgeTriggerLevelType) | Sets the reference for the SetIQPowerEdgeTriggerLevel(string, double) method. This method is used only when you set the SetTriggerType(string, RFmxDemodMXTriggerType) method to IQPowerEdge. |
| SetIQPowerEdgeTriggerSlope(string, RFmxDemodMXIQPowerEdgeTriggerSlope) | Sets whether the device asserts the trigger when the signal power is rising or falling. |
| SetIQPowerEdgeTriggerSource(string, string) | Sets the channel from which the device monitors the trigger. |
| SetLimitedConfigurationChange(string, RFmxDemodMXLimitedConfigurationChange) | Sets the set of properties that are considered by RFmx in the locked signal configuration state. |
| SetReferenceLevel(string, double) | 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. |
| SetReferenceLevelHeadroom(string, double) | 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 |
| SetResultFetchTimeout(string, double) | 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. |
| SetSelectedPorts(string, string) | Sets the instrument port to be configured to acquire a signal. Valid values |
| SetTriggerDelay(string, double) | Sets the trigger delay time, in seconds. |
| SetTriggerMinimumQuietTimeDuration(string, double) | Sets the time duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q power-edge trigger. |
| SetTriggerMinimumQuietTimeMode(string, RFmxDemodMXTriggerMinimumQuietTimeMode) | Sets whether the measurement computes the minimum quiet time used for triggering. |
| SetTriggerType(string, RFmxDemodMXTriggerType) | Sets the type of reference trigger to use for signal acquisition. |
| WaitForMeasurementComplete(string, double) | Waits for the number for seconds specified using the timeout parameter for all measurements to complete. |
| BuildResultString(string) | Creates the selector string for use with Configuration or Fetch methods. |