RFmxTdscdmaMX Methods

Stops the acquisition and measurements associated with the signal instance that you specify in the selectorString parameter. The acquisition and measurements 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 the 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. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionTypeMethod method value is either IQ or IQorSpectral.
Query the Recommended Acquisition Type method from the RFmx driver after calling the RFmxTDSCDMA Commit method.

Performs the enabled measurements on the Spectrum waveform that you specify in the 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. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionTypeMethod method value is either spectral or IQorSpectral.
Query the Recommended Acquisition Type method from the RFmx driver after calling the RFmxTDSCDMA Commit method.

Examines the input signal to calculate the peak power level and sets it as the value of the Reference Level method. Use this method to calculate an approximate setting for the reference level.
The RFmxTDSCDMA 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 the SetAutoLevelInitialReferenceLevel(String, Double) method.
When using PXIe-5663/5665/5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmxTDSCDMA 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 selector string to use with channel-specific configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.

Creates the offset string to use as the selector string with spectral emissions mask (SEM) and adjacent channel power (ACP) offset configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.

Creates selector string for use with configuration or fetch.

Creates the segment string to use as the selector string with the power versus time (PVT) segment configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.

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. RFmxTDSCDMA commits settings to the hardware when you call the Initiate(String, String) method.

Configures RFmx TD-SCDMA to detect the channels automatically or to use a specified channel configuration.

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

Specifies external attenuation to be considered by RFmx TD-SCDMA measurements, such as the attenuation of a switch or cable connected to the signal analyzer RF IN connector.

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.

Configures the carrier frequency of the RF signal to acquire according to the given channel number. The signal analyzer tunes to this frequency.

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.

This method is now deprecated, please use the RFmxTDSCDMA Configure Midamble Shift method in the place of this method.

Configures the midambleAutoDetectionMode, maximumNumberOfUsers, and MidambleShift parameters.

Configures the number of channels for the user-defined channel configuration when the channel configuration mode is set to userDefined.

Configures the pilot code of the TD-SCDMA signal.

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

Configures the RF methods of the signal specified by the selectorString parameter.

Configures the device to wait for a software trigger to mark a reference point within the record.

Configures the scrambling code used for the uplink transmission.

Configures an individual user-defined channel when the channel configuration mode is set to userDefined.
Use "channel(n)" as the selector string to configure this method.
A channel configuration is defined by the slot index it refers to, the channel type, and the modulation type.

Configures all user-defined channels when the channel configuration mode is set to userDefined.
Use equal-sized arrays for slotIndex, channelType, and modulationType. You can configure up to two channels for the same index for multi-code transmission.

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.

Returns all the named result names of the current signal instance.

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 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 carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.

Gets whether to detect the channels automatically or to use a specified channel configuration.

Gets the channelization code of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Gets the channel type of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

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

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

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

Gets the level of external attenuation that is considered by the selected measurement. This value is expressed in dB.

Serves as a hash function for a particular type.

Gets the threshold above or below which the signal analyzer triggers, depending on the value of the SetIQPowerEdgeTriggerSlope(String, RFmxTdscdmaMXIQPowerEdgeTriggerSlope) method. This value is expressed in dB when the SetIQPowerEdgeTriggerLevelType(String, RFmxTdscdmaMXIQPowerEdgeTriggerLevelType) method is set to Relative or in dBm when the IQ Power Edge Level Type method is set to Absolute.

Gets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxTdscdmaMXTriggerType) method to IQPowerEdge.

Gets whether the device asserts the trigger when the signal power is rising or when the signal power 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, RFmxTdscdmaMXTriggerType) method to IQPowerEdge.

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

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

Configures the maximum number of users.

Gets the midamble auto detection mode.

Gets the midamble code.

Gets the midamble shift used when you set the SetMidambleAutoDetectionMode(String, RFmxTdscdmaMXMidambleAutoDetectionMode) method to Off. This value is expressed in chips.

Gets the modulation type of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Gets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined.

Gets the SYNC-UL code used by the uplink pilot time slot (UpPTS). This method is used when the SetSynchronizationMode(String, RFmxTdscdmaMXModAccSynchronizationMode) method is set to Subframe, or the SetSlotType(String, RFmxTdscdmaMXModAccSlotType) method is set to Pilot.

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 V_pk-pk for baseband devices.

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.

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

Gets the instrument port to be used by the measurement.

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 spreading factor, the number of TFCI code words, the number of transmit power control bits, and the number of synchronization shift bits. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Gets the slot index of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Gets the trigger delay time. This value is expressed in seconds.

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 SetIQPowerEdgeTriggerSlope(String, RFmxTdscdmaMXIQPowerEdgeTriggerSlope) 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.

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

Gets the trigger type.

Gets the Type of the current instance.

Gets the scrambling code and the basic midamble code for uplink transmission.

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. To get the status of measurements, use the WaitForMeasurementComplete(String, Double) method or the CheckMeasurementStatus(String, Boolean) method.

Resets the attribute to its default value.

Resets a signal to the default values. This method disables all the external attenuation tables in all calibration planes.

Specifies the measurements that you want to enable.

Sends a trigger to the device when you use the RFmxTDSCDMA_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:

1. You configure an invalid trigger.
2. You have not previously called the RFmxMXTdscdmaMX.Initiate method.

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 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 carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.

Sets whether to detect the channels automatically or to use a specified channel configuration.

Sets the channelization code of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Sets the channel type of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

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

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

Sets the level of external attenuation that is considered by the selected measurement. This value is expressed in dB.

Sets the threshold above or below which the signal analyzer triggers, depending on the value of the SetIQPowerEdgeTriggerSlope(String, RFmxTdscdmaMXIQPowerEdgeTriggerSlope) method. This value is expressed in dB when the SetIQPowerEdgeTriggerLevelType(String, RFmxTdscdmaMXIQPowerEdgeTriggerLevelType) method is set to Relative or in dBm when the IQ Power Edge Level Type method is set to Absolute.

Sets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxTdscdmaMXTriggerType) method to IQPowerEdge.

Sets whether the device asserts the trigger when the signal power is rising or when the signal power 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, RFmxTdscdmaMXTriggerType) method to IQPowerEdge.

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

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

Configures the maximum number of users.

Sets the midamble auto detection mode.

Sets the midamble code.

Sets the midamble shift used when you set the SetMidambleAutoDetectionMode(String, RFmxTdscdmaMXMidambleAutoDetectionMode) method to Off. This value is expressed in chips.

Sets the modulation type of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Sets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined.

Sets the SYNC-UL code used by the uplink pilot time slot (UpPTS). This method is used when the SetSynchronizationMode(String, RFmxTdscdmaMXModAccSynchronizationMode) method is set to Subframe, or the SetSlotType(String, RFmxTdscdmaMXModAccSlotType) method is set to Pilot.

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 V_pk-pk for baseband devices.

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.

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

Sets the instrument port to be used by the measurement.

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 spreading factor, the number of TFCI code words, the number of transmit power control bits, and the number of synchronization shift bits. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Sets the slot index of the user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxTdscdmaMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the selector string to configure or read this method.

Sets the trigger delay time. This value is expressed in seconds.

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 SetIQPowerEdgeTriggerSlope(String, RFmxTdscdmaMXIQPowerEdgeTriggerSlope) 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.

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

Sets the trigger type.

Sets the scrambling code and the basic midamble code for uplink transmission.

Returns a string that represents the current object.

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