RFmxLteMX Methods

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.

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 Recommended Acquisition Type method value is either IQ or IQorSpectral.
When using the Analysis-Only mode in RFmxLTE, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM.
Query the Recommended Acquisition Type method from the RFmxInstr Property Node after calling the RFmx LTE Commit method.

Performs the enabled measurements on the spectrum waveform that you specify in spectrum 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 Recommended Acquisition Type method value is either spectral or IQorSpectral.
When using the Analysis-Only mode in RFmxLTE, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM.
Query the Recommended Acquisition Type method from the RFmxInstr Property Node after calling the RFmx LTE Commit method.

Examines the input signal to calculate the peak power level and sets it as the value of the SetReferenceLevel(String, Double) method. Use this method to calculate an approximate setting for the reference level.
The RFmxLTE Auto Level method completes the following tasks:

1. Resets the mixer level, mixer level offset, and IF output power offset.
   
2. Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation, and preamplifier enabled settings.
   
3. Iterates to adjust the reference level based on the input signal peak power.
   
4. Uses immediate triggering and restores the trigger settings back to user setting after the execution.
   

You can also specify the starting reference level using SetAutoLevelInitialReferenceLevel(String, Double) method.
When using NI 5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmxLTE Auto Level method. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this method; thus reducing wear and tear, and maximizing the life time of the attenuator.

Creates a carrier string to use as a selector string with the SEM and ACP carrier configurations or fetch methods and methods.

Creates a cluster string to use as a selector string with the ModAcc cluster configuration or fetch methods and methods.

Creates the list step string.

Creates the list string.

Creates an offset string to use as a selector string with SEM and ACP offset configuration or fetch methods and methods.

Creates a PDSCH string to use as a selector string with the configuration or fetch methods and methods.

Creates selector string for use with configuration or fetch.

Creates a subblock string to use as a selector string with the subblock configuration or fetch methods and methods.

Creates a subframe string to use as a selector string with the configuration or fetch methods and methods.

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.

Clears all results for the current signal instance.

Clears a result instance specified by the result name in the selectorString parameter.

Creates a new instance of a signal by copying all the method values from an existing signal instance.

Commits settings to the hardware. Calling this method is optional. RFmxLTE commits settings to the hardware when you call the Initiate(String, String) method.

Configures whether the demodulation reference signal (DMRS) parameters are configured by a user or automatically detected by a measurement.

Configures the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock.
Use "subblock(n)" as the selector string to configure this method.

Configures the device to wait for a digital edge trigger and then marks a reference point within the record.

Configures the duplexing technique of the signal being measured.

Configures the eNodeB category of the signal being measured.

Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer.

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.
Use "subblock(n)" as the selector string to configure this method.

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to the E-UTRA absolute radio frequency channel number (EARFCN) frequency.
Use "subblock(n)" as the selector string to configure this method.

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.

Configures the link direction of the signal being measured.

Configures the number of component carriers within a subblock.
Use "subblock(n)" as the selector string to configure this method.

Configures the number of physical antennas used for transmission by the DUT in a MIMO setup.

Configures the number of subblocks.

Configures the reference level, which represents the maximum expected power of an RF input signal.

Configures the RF methods of the signal specified by the selector string.

Configures the device to wait for a software trigger and then marks a reference point within the record.

Configures the current physical antenna of the DUT in the MIMO setup being tested.

Deletes an instance of a signal.

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.

Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any.

Determines whether the specified Object is equal to the current Object.

Gets whether RFmx driver optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.

Gets the named result names of the signal that you specify in the selectorString parameter.

Gets the value of a Bool attribute.

Gets the value of a Double attribute.

Gets the value of an RFmx 32-bit integer (int32) attribute.

Gets the value of a of an RFmx string.

Gets whether you configure the values of the demodulation reference signal (DMRS) parameters, such as SetUplinkGroupHoppingEnabled(String, RFmxLteMXUplinkGroupHoppingEnabled), SetUplinkSequenceHoppingEnabled(String, RFmxLteMXUplinkSequenceHoppingEnabled), SetCellId(String, Int32), SetPuschNDmrs1(String, Int32), SetPuschNDmrs2(String, Int32), and SetPuschDeltaSequenceShift(String, Int32) properties, or if the values of these properties are auto-detected by the measurement.

Gets the initial reference level that the AutoLevel(String, Double, Double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.

Gets the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.

For a single carrier, this method specifies the center frequency of the acquired RF signal.

Gets the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.

Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to DigitalEdge.

Gets the source terminal for the digital edge trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to DigitalEdge.

Gets the duplexing technique of the signal being measured.

Gets the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.

Converts the status code returned by an RFmxLTE function into a string.

Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.

Serves as a hash function for a particular type.

Gets the power level at which the device triggers. This value is expressed in dB when you set the SetIQPowerEdgeTriggerLevelType(String, RFmxLteMXIQPowerEdgeTriggerLevelType) 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 SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Gets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. The IQ Power Edge Level Type method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

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 specified level with the slope you specify. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Gets the channel from which the device monitors the trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Gets the set of properties that are considered by RFmx driver in the locked signal configuration state.

Gets the link direction of the received signal.

Gets the duration of a given list step in units specified by SetListStepTimerUnit(String, RFmxLteMXListStepTimerUnit).

Gets the offset from the start of the step for which the measurements are computed. The unit for this method is specified by SetListStepTimerUnit(String, RFmxLteMXListStepTimerUnit). This method is valid only when you set the SetDigitalEdgeTriggerSource(String, String) method to TimerEvent

Gets the units in which SetListStepTimerDuration(String, Double) and SetListStepTimerOffset(String, Double) are specified.

Gets whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the SetDuplexScheme(String, RFmxLteMXDuplexScheme) method to Tdd.

Gets the number of physical antennas available at the DUT for transmission in a MIMO setup.

Gets the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.

Gets the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.

Gets the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.

Gets the margin RFmx driver adds to the SetReferenceLevel(String, Double) method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

Default values

PXIe-5668: 6 dB

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

PXIe-5840: 0 dB

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

Gets the time to wait before results are available in the RFmxLTE_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 RFmx Property Node waits until the measurement is complete.

Gets the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names.

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

Gets the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.

Gets the offset of the subblock from the center frequency. This value is expressed in Hz.

Gets the physical antenna connected to the analyzer.

Gets the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.

Gets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre trigger samples. If the delay is positive, the measurement acquires post trigger samples.

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.

Gets whether the measurement computes the minimum quiet time used for triggering.

Gets the trigger type.

Gets the Type of the current instance.

Gets the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.

Gets the latest warning code and description.

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 WaitForMeasurementComplete(String, Double) method or CheckMeasurementStatus(String, Boolean) method.

Resets the attribute to its default value.

Resets a signal to the default values.

Specifies the measurements that you want to enable.

Sends a trigger to the device when you use the RFmxLTE_CfgTrigger 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.
This method returns an error in the following situations:

• You configure an invalid trigger.
  
• You have not previously called the Initiate(String, String) method.
  

Sets whether RFmx driver optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.

Sets the value of a Bool attribute.

Sets the value of a Double attribute.

Sets the value of a Int attribute.

Sets the value of a String attribute.

Sets whether you configure the values of the demodulation reference signal (DMRS) parameters, such as SetUplinkGroupHoppingEnabled(String, RFmxLteMXUplinkGroupHoppingEnabled), SetUplinkSequenceHoppingEnabled(String, RFmxLteMXUplinkSequenceHoppingEnabled), SetCellId(String, Int32), SetPuschNDmrs1(String, Int32), SetPuschNDmrs2(String, Int32), and SetPuschDeltaSequenceShift(String, Int32) properties, or if the values of these properties are auto-detected by the measurement.

Sets the initial reference level that the AutoLevel(String, Double, Double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.

Sets the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.

For a single carrier, this method specifies the center frequency of the acquired RF signal.

Sets the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. If you do not set a value for this method, the measurement internally uses RFmxLteMX.SetCenterFrequency for determining SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.

Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to DigitalEdge.

Sets the source terminal for the digital edge trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to DigitalEdge.

Sets the duplexing technique of the signal being measured.

Sets the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.

Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.

Sets the power level at which the device triggers. This value is expressed in dB when you set the SetIQPowerEdgeTriggerLevelType(String, RFmxLteMXIQPowerEdgeTriggerLevelType) 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 SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Sets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. The IQ Power Edge Level Type method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

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 specified level with the slope you specify. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Sets the channel from which the device monitors the trigger. This method is used only when you set the SetTriggerType(String, RFmxLteMXTriggerType) method to IQPowerEdge.

Sets the set of properties that are considered by RFmx driver in the locked signal configuration state.

Sets the link direction of the received signal.

Sets the duration of a given list step in units specified by SetListStepTimerUnit(String, RFmxLteMXListStepTimerUnit).

Sets the offset from the start of the step for which the measurements are computed. The unit for this method is specified by SetListStepTimerUnit(String, RFmxLteMXListStepTimerUnit). This method is valid only when you set the SetDigitalEdgeTriggerSource(String, String) method to TimerEvent.

Sets the units in which SetListStepTimerDuration(String, Double) and SetListStepTimerOffset(String, Double) are specified.

Sets whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the SetDuplexScheme(String, RFmxLteMXDuplexScheme) method to Tdd.

Sets the number of physical antennas available at the DUT for transmission in a MIMO setup.

Sets the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.

Sets the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.

Sets the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.

Sets the margin RFmx driver adds to the SetReferenceLevel(String, Double) method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

Default values

PXIe-5668: 6 dB

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

PXIe-5840: 0 dB

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

Sets the time to wait before results are available in the RFmxLTE_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 RFmx Property Node waits until the measurement is complete.

Sets the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names.

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

Sets the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.

Sets the offset of the subblock from the center frequency. This value is expressed in Hz.

Sets the physical antenna connected to the analyzer.

Sets the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.

Sets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre trigger samples. If the delay is positive, the measurement acquires post trigger samples.

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.

Sets whether the measurement computes the minimum quiet time used for triggering.

Sets the trigger type.

Sets the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.

Returns a string that represents the current object.

Waits for the specified number for seconds for all the measurements to complete.