RFmxPulseMX Class
- Updated2025-10-13
- 10 minute(s) read
Defines a root class which is used to identify and control PULSE signal configuration.
Derives from
- ISignalConfiguration
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.PulseMX
public class RFmxPulseMX : ISignalConfiguration, IDisposable
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| Pulse | Gets the RFmxPulseMXPulse instance that represents the Pulse measurement. |
| SignalConfigurationName | Gets the signal configuration name. |
| SignalConfigurationType | Gets the Type object for RFmxPulseMX. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | Stops acquisition and measurements associated with signal instance that you specify in the selectorString parameter, which were previously initiated by the Initiate(string, string) method or measurement read methods. Calling this method is optional, unless you want to stop a measurement before it is complete. This method executes even if there is an incoming error. |
| 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 methods. You can fetch measurement results using the Fetch methods or result methods in the method node. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionType method value is either IQ or IQorSpectral. |
| AutoLevel(string, double, double, out double) | Examines the input signal to calculate the peak power level and sets it as the value of the ReferenceLevel method. Use this method to help calculate an approximate setting for the reference level. |
| CheckMeasurementStatus(string, out bool) | Checks the status of the measurement. Use this method to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available. |
| 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 RFmxPulseMX) | Creates a new instance of a signal by copying all the method values from an existing signal instance. |
| Commit(string) | Commits settings to the hardware. Calling this method is optional. RFmxPulse commits settings to the hardware when you call the Initiate(string, string) method or any of the measurement Read methods. |
| ConfigureDigitalEdgeTrigger(string, string, RFmxPulseMXDigitalEdgeTriggerEdge, double, bool) | Configures the device to wait for a digital edge trigger and then marks a reference point within the record. |
| ConfigureExternalAttenuation(string, double) | Specifies 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 to acquire. The signal analyzer tunes to this frequency. |
| ConfigureIQPowerEdgeTrigger(string, string, RFmxPulseMXIQPowerEdgeTriggerSlope, double, double, RFmxPulseMXTriggerMinimumQuietTimeMode, double, RFmxPulseMXIQPowerEdgeTriggerLevelType, bool) | Configures the device to wait for the complex power of the I/Q data to cross the specified threshold to mark a reference point within the record. |
| ConfigureReferenceLevel(string, double) | Configures the reference level, which represents the maximum expected power of an RF input signal. |
| ConfigureRF(string, double, double, double) | Configures the RF methods of the signal specified by the selector string. |
| ConfigureSoftwareEdgeTrigger(string, double, bool) | Configures the device to wait for a software trigger and then marks a reference point within the record. |
| DeleteSignalConfiguration() | Deletes an instance of a signal. |
| DisableTrigger(string) | Configures the device to not wait for a trigger to mark a reference point within a record. This method defines the signal triggering as immediate. |
| Dispose() | Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any. |
| GetAcquisitionLength(string, out double) | Gets the acquisition length for the pulse measurement. This value is expressed in seconds.You configure this method when you set the SegmentedAcquisitionEnabled method to False. |
| GetAllNamedResultNames(string, out string[], out bool) | Gets the named result names of the signal that you specify in the selectorString parameter. |
| GetAttributeBool(string, int, out bool) | Gets the value of a Bool attribute. |
| GetAttributeDouble(string, int, out double) | Gets the value of a Double attribute. |
| GetAttributeDoubleArray(string, int, ref double[]) | Gets the value of a double array attribute. |
| GetAttributeInt(string, int, out int) | Gets the value of an RFmx 32-bit integer (int32) attribute. |
| GetAttributeIntArray(string, int, ref int[]) | Gets the value of a integer array attribute. |
| GetAttributeString(string, int, out string) | Gets the value of a of an RFmx string. |
| GetAutoLevelInitialReferenceLevel(string, out double) | Gets the initial reference level, in dBm, which the AutoLevel(string, double, double, out double) function uses to estimate the peak power of the input signal. |
| GetCenterFrequency(string, out double) | Gets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency. |
| GetDigitalEdgeTriggerEdge(string, out RFmxPulseMXDigitalEdgeTriggerEdge) | Gets the active edge for the trigger. This method is used only when you set the TriggerType method to DigitalEdge. |
| GetDigitalEdgeTriggerSource(string, out string) | Gets the source terminal for the digital edge trigger. This method is used only when you set the TriggerType method to DigitalEdge. |
| GetError(out int, out string) | Gets the latest error code and description. |
| GetErrorString(int, out string) | Converts the status code returned by an RFmxPULSE function into a string. |
| GetExternalAttenuation(string, out double) | Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. |
| GetIQPowerEdgeTriggerLevel(string, out double) | Gets the power level at which the device triggers. This value is expressed in dB when you set the IQPowerEdgeTriggerLevelType method to Relative and in dBm when you set the IQ Power Edge Level Type 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 TriggerType method to IQPowerEdge. |
| GetIQPowerEdgeTriggerLevelType(string, out RFmxPulseMXIQPowerEdgeTriggerLevelType) | Gets the reference for the IQPowerEdgeTriggerLevel method. The IQ Power Edge Level Type method is used only when you set the TriggerType method to IQPowerEdge. |
| GetIQPowerEdgeTriggerSlope(string, out RFmxPulseMXIQPowerEdgeTriggerSlope) | Gets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQPowerEdgeTriggerLevel method with the slope you specify. This method is used only when you set the TriggerType method to IQPowerEdge. |
| GetIQPowerEdgeTriggerSource(string, out string) | Gets the channel from which the device monitors the trigger. This method is used only when you set the TriggerType method to IQPowerEdge. |
| GetMaximumPulseCount(string, out int) | Gets the maximum number of pulses to be measured when you set the MaximumPulseCountEnabled method to True. |
| GetMaximumPulseCountEnabled(string, out RFmxPulseMXMaximumPulseCountEnabled) | Gets whether to enable the maximum pulse count for pulse measurements.You must configure this method when you set the SegmentedAcquisitionEnabled method to False. |
| GetMeasurementBandwidth(string, out double) | Gets the bandwidth of the filter used for the required sample rate. This value is expressed in Hz. |
| GetMeasurementFilterType(string, out RFmxPulseMXMeasurementFilterType) | Gets the demodulation filter type to be used in the measurements. |
| GetNumberOfSegments(string, out int) | Gets the number of segments to acquire when you set the SegmentedAcquisitionEnabled method to True. |
| GetReferenceLevel(string, out double) | Gets the reference level that 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 ReferenceLevel method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. |
| GetResultFetchTimeout(string, out double) | Gets the wait time before results are available in the PropertyNode. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxPulse Property Node waits until the measurement is complete. |
| GetSegmentAcquisitionLength(string, out double) | Gets the acquisition length for the pulse measurement when you set the SegmentedAcquisitionEnabled method to True. This value is expressed in seconds. |
| GetSegmentedAcquisitionEnabled(string, out RFmxPulseMXSegmentedAcquisitionEnabled) | Gets whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced. |
| GetSelectedPorts(string, out string) | Gets the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names. |
| GetTriggerDelay(string, out double) | Gets the trigger delay time. This value is expressed in seconds.If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. |
| GetTriggerMinimumQuietTimeDuration(string, out double) | Gets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds. If you set the IQPowerEdgeTriggerSlope method to Rising, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope method to Falling, the signal is quiet above the trigger level. |
| GetTriggerMinimumQuietTimeMode(string, out RFmxPulseMXTriggerMinimumQuietTimeMode) | Gets whether the measurement computes the minimum quiet time used for triggering. |
| GetTriggerType(string, out RFmxPulseMXTriggerType) | Gets the trigger type. |
| GetWarning(out int, out string) | Gets the latest warning code and description. |
| 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. You can fetch measurement results using the Fetch methods or result methods in the method node. To get the status of measurements, use the RF WaitForMeasurementComplete(string, double) method or CheckMeasurementStatus(string, out bool) method. |
| ResetAttribute(string, RFmxPulseMXPropertyId) | Resets the attribute to its default value. |
| ResetToDefault(string) | Resets a signal to the default values. |
| SelectMeasurements(string, RFmxPulseMXMeasurementTypes, bool) | Specifies the measurements that you want to enable. |
| SendSoftwareEdgeTrigger() | Sends a trigger to the device when you use the ConfigureSoftwareEdgeTrigger(string, double, bool) method 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. |
| SetAcquisitionLength(string, double) | Sets the acquisition length for the pulse measurement. This value is expressed in seconds.You configure this method when you set the SegmentedAcquisitionEnabled method to False. |
| SetAttributeBool(string, int, bool) | Sets the value of a Bool attribute. |
| SetAttributeDouble(string, int, double) | Sets the value of a Double attribute. |
| SetAttributeDoubleArray(string, int, double[]) | Set the value of a double array attribute. |
| SetAttributeInt(string, int, int) | Sets the value of a Int attribute. |
| SetAttributeIntArray(string, int, int[]) | Set the value of a integer array attribute. |
| SetAttributeString(string, int, string) | Sets the value of a String attribute. |
| SetAutoLevelInitialReferenceLevel(string, double) | Sets the initial reference level, in dBm, which the AutoLevel(string, double, double, out double) function uses to estimate the peak power of the input signal. |
| SetCenterFrequency(string, double) | Sets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency. |
| SetDigitalEdgeTriggerEdge(string, RFmxPulseMXDigitalEdgeTriggerEdge) | Sets the active edge for the trigger. This method is used only when you set the TriggerType method to DigitalEdge. |
| SetDigitalEdgeTriggerSource(string, string) | Sets the source terminal for the digital edge trigger. This method is used only when you set the TriggerType method to DigitalEdge. |
| SetExternalAttenuation(string, double) | Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. |
| SetIQPowerEdgeTriggerLevel(string, double) | Sets the power level at which the device triggers. This value is expressed in dB when you set the IQPowerEdgeTriggerLevelType method to Relative and in dBm when you set the IQ Power Edge Level Type 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 TriggerType method to IQPowerEdge. |
| SetIQPowerEdgeTriggerLevelType(string, RFmxPulseMXIQPowerEdgeTriggerLevelType) | Sets the reference for the IQPowerEdgeTriggerLevel method. The IQ Power Edge Level Type method is used only when you set the TriggerType method to IQPowerEdge. |
| SetIQPowerEdgeTriggerSlope(string, RFmxPulseMXIQPowerEdgeTriggerSlope) | Sets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQPowerEdgeTriggerLevel method with the slope you specify. This method is used only when you set the TriggerType method to IQPowerEdge. |
| SetIQPowerEdgeTriggerSource(string, string) | Sets the channel from which the device monitors the trigger. This method is used only when you set the TriggerType method to IQPowerEdge. |
| SetMaximumPulseCount(string, int) | Sets the maximum number of pulses to be measured when you set the MaximumPulseCountEnabled method to True. |
| SetMaximumPulseCountEnabled(string, RFmxPulseMXMaximumPulseCountEnabled) | Sets whether to enable the maximum pulse count for pulse measurements.You must configure this method when you set the SegmentedAcquisitionEnabled method to False. |
| SetMeasurementBandwidth(string, double) | Sets the bandwidth of the filter used for the required sample rate. This value is expressed in Hz. |
| SetMeasurementFilterType(string, RFmxPulseMXMeasurementFilterType) | Sets the demodulation filter type to be used in the measurements. |
| SetNumberOfSegments(string, int) | Sets the number of segments to acquire when you set the SegmentedAcquisitionEnabled method to True. |
| SetReferenceLevel(string, double) | Sets the reference level that 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 ReferenceLevel method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. |
| SetResultFetchTimeout(string, double) | Sets the wait time before results are available in the RFmx Property. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxPulse Property Node waits until the measurement is complete. |
| SetSegmentAcquisitionLength(string, double) | Sets the acquisition length for the pulse measurement when you set the SegmentedAcquisitionEnabled method to True. This value is expressed in seconds. |
| SetSegmentedAcquisitionEnabled(string, RFmxPulseMXSegmentedAcquisitionEnabled) | Sets whether to enable Segmented Acquisition. This mode is best applied when the pulses are sparsely spaced. |
| SetSelectedPorts(string, string) | Sets the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names. |
| SetTriggerDelay(string, double) | Sets the trigger delay time. This value is expressed in seconds.If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. |
| SetTriggerMinimumQuietTimeDuration(string, double) | Sets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds. If you set the IQPowerEdgeTriggerSlope method to Rising, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope method to Falling, the signal is quiet above the trigger level. |
| SetTriggerMinimumQuietTimeMode(string, RFmxPulseMXTriggerMinimumQuietTimeMode) | Sets whether the measurement computes the minimum quiet time used for triggering. |
| SetTriggerType(string, RFmxPulseMXTriggerType) | Sets the trigger type. |
| WaitForMeasurementComplete(string, double) | Waits for the specified number for seconds for all the measurements to complete. |
| BuildResultString(string) | Creates selector string for use with configuration or fetch. |