RFmxCdma2kMX Class
- Updated2025-04-08
- 13 minute(s) read
Defines a root class which is used to identify and control CDMA2k signal configuration.
Derives from
- ISignalConfiguration
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.Cdma2kMX
public class RFmxCdma2kMX : ISignalConfiguration, IDisposable
Properties
| Name | Description |
|---|---|
| Acp | Gets the RFmxCdma2kMXAcp instance that represents the ACP measurement. |
| Cda | Gets the RFmxCdma2kMXCda instance that represents the CDA measurement. |
| Chp | Gets the RFmxCdma2kMXChp instance that represents the CHP measurement. |
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| ModAcc | Gets the RFmxCdma2kMXModAcc instance that represents the ModAcc measurement. |
| Obw | Gets the RFmxCdma2kMXObw instance that represents the OBW measurement. |
| Qevm | Gets the RFmxCdma2kMXQevm instance that represents the QEVM measurement. |
| Sem | Gets the RFmxCdma2kMXSem instance that represents the SEM measurement. |
| SignalConfigurationName | Gets the signal configuration name. |
| SignalConfigurationType | Gets the Type object for RFmxCdma2kMX. |
| SlotPhase | Gets the RFmxCdma2kMXSlotPhase instance that represents the SlotPhase measurement. |
| SlotPower | Gets the RFmxCdma2kMXSlotPower instance that represents the SlotPower measurement. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | Stops 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. |
| 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. |
| AnalyzeSpectrum1Waveform(string, string, Spectrum< float >, bool, long) | 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 RFmxInstrMX.GetRecommendedAcquisitionType method value is either spectral or IQorSpectral. |
| AutoLevel(string, double, out double) | 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. |
| 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 RFmxCdma2kMX) | 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. RFmxCDMA2k commits settings to the hardware when you call the Initiate(string, string) method. |
| ConfigureBandClass(string, int) | Configures the band class used for the measurement. |
| ConfigureChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) | Configures RFmx CDMA2k to detect the channels automatically or to use a specified channel configuration. |
| ConfigureDigitalEdgeTrigger(string, string, RFmxCdma2kMXDigitalEdgeTriggerEdge, 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 any external attenuation to be considered by RFmx CDMA2k measurements, such as the attenuation of a switch or cable connected to the signal analyzer RF IN connector. |
| ConfigureFrequency(string, double) | Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. |
| ConfigureFrequencyChannelNumber(string, int, int, int) | Configures the expected carrier frequency of the RF signal to acquire according to the given channel number. The signal analyzer tunes to this frequency. |
| ConfigureFrequencyChannelNumber(string, RFmxCdma2kMXLinkDirection, int, int) | Configures the expected carrier frequency of the RF signal to acquire according to the given channel number. The signal analyzer tunes to this frequency. |
| ConfigureIQPowerEdgeTrigger(string, string, RFmxCdma2kMXIQPowerEdgeTriggerSlope, double, double, RFmxCdma2kMXTriggerMinimumQuietTimeMode, double, RFmxCdma2kMXIQPowerEdgeTriggerLevelType, 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. |
| ConfigureNumberOfChannels(string, int) | Configures the number of channels for the user-defined channel configuration when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined. |
| ConfigureRadioConfiguration(string, RFmxCdma2kMXRadioConfiguration) | Configures the radio configuration of the CDMA2k signal. |
| ConfigureReferenceLevel(string, double) | Configures the reference level. The reference level represents the maximum expected power of an input RF signal. |
| ConfigureRF(string, double, double, double) | Configures the RF methods of the signal specified by the selectorString parameter. |
| ConfigureSoftwareEdgeTrigger(string, double, bool) | Configures the device to wait for a software trigger and then marks a reference point within the record. |
| ConfigureUplinkSpreading(string, long) | Configures the scrambling code used for the uplink transmission. |
| ConfigureUserDefinedChannel(string, int, int, RFmxCdma2kMXBranch) | Configures an individual user-defined channel when the channel configuration mode is set to userDefined. |
| ConfigureUserDefinedChannelArray(string, int[], int[], RFmxCdma2kMXBranch[]) | Configures all user-defined channels when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined. |
| 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. |
| 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 Bool attribute. |
| GetAttributeDouble(string, int, out double) | Gets the value of a Double attribute. |
| GetAttributeInt(string, int, out int) | Gets the value of an RFmx 32-bit integer (int32) attribute. |
| GetAttributeLong(string, int, out long) | Gets the value of an RFmx 64-bit integer (int64) attribute. |
| GetAttributeString(string, int, out string) | Gets the value of a of an RFmx string. |
| GetAutoLevelInitialReferenceLevel(string, out double) | Gets the initial reference level that the AutoLevel(string, double, out double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.The default value is 30Â dBm. |
| GetBandClass(string, out int) | Gets the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0. |
| GetBranch(string, out RFmxCdma2kMXBranch) | Gets the branch on which a specific user-defined channel is mapped. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| GetCenterFrequency(string, out double) | Gets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz. |
| GetChannelConfigurationMode(string, out RFmxCdma2kMXChannelConfigurationMode) | Gets whether to detect the channels automatically or to use a specified channel configuration. |
| GetDigitalEdgeTriggerEdge(string, out RFmxCdma2kMXDigitalEdgeTriggerEdge) | Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(string, RFmxCdma2kMXTriggerType) 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 SetTriggerType(string, RFmxCdma2kMXTriggerType) method to DigitalEdge. |
| GetDownlinkSpreadingPNOffset(string, out int) | Specified the PN offset in increments of 64 chips for forward link. |
| GetError(out int, out string) | Gets the latest error code and description. |
| GetErrorString(int, out string) | Converts the status code returned by an RFmxCDMA2k 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 the SetIQPowerEdgeTriggerLevelType(string, RFmxCdma2kMXIQPowerEdgeTriggerLevelType) method is set to Relative and in dBm when the IQ Power Edge Level Type method is set 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, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| GetIQPowerEdgeTriggerLevelType(string, out RFmxCdma2kMXIQPowerEdgeTriggerLevelType) | Gets the reference for the IQ Power Edge Level Type method. This method is used only when you set the SetTriggerType(string, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| GetIQPowerEdgeTriggerSlope(string, out RFmxCdma2kMXIQPowerEdgeTriggerSlope) | 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, RFmxCdma2kMXTriggerType) 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 SetTriggerType(string, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| GetLimitedConfigurationChange(string, out RFmxCdma2kMXLimitedConfigurationChange) | Gets the set of properties that are considered by RFmx in the locked signal configuration state. |
| GetLinkDirection(string, out RFmxCdma2kMXLinkDirection) | Gets the link direction of the received signal. |
| GetNumberOfChannels(string, out int) | Gets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined. |
| GetRadioConfiguration(string, out RFmxCdma2kMXRadioConfiguration) | Gets the radio configuration for the channel. |
| 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 to wait before results are available. 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. |
| 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. This value is expressed in seconds. |
| 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 SetIQPowerEdgeTriggerSlope(string, RFmxCdma2kMXIQPowerEdgeTriggerSlope) 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 RFmxCdma2kMXTriggerMinimumQuietTimeMode) | Gets whether the measurement computes the minimum quiet time used for triggering. |
| GetTriggerType(string, out RFmxCdma2kMXTriggerType) | Gets the trigger type. |
| GetUplinkSpreadingLongCodeMask(string, out long) | Gets the long code mask for reverse link spreading. |
| GetWalshCodeLength(string, out int) | Gets the Walsh code length of a specific user-defined channel. This value is expressed in chips. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| GetWalshCodeNumber(string, out int) | Gets the Walsh code number of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| 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. |
| ResetAttribute(string, RFmxCdma2kMXPropertyId) | Resets the attribute to its default value. |
| ResetToDefault(string) | Resets a signal configuration to the default values. |
| SelectMeasurements(string, RFmxCdma2kMXMeasurementTypes, bool) | Specifies the measurements that you want to enable. |
| SendSoftwareEdgeTrigger() | Sends a trigger to the device when you use the RFmxCDMA2k_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. |
| SetAttributeBool(string, int, bool) | Sets the value of a Bool attribute. |
| SetAttributeDouble(string, int, double) | Sets the value of a Double attribute. |
| SetAttributeInt(string, int, int) | Sets the value of a Int attribute. |
| SetAttributeLong(string, int, long) | Sets the value of a Long attribute. |
| SetAttributeString(string, int, string) | Sets the value of a String attribute. |
| SetAutoLevelInitialReferenceLevel(string, double) | Sets the initial reference level that the AutoLevel(string, double, out double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.The default value is 30Â dBm. |
| SetBandClass(string, int) | Sets the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0. |
| SetBranch(string, RFmxCdma2kMXBranch) | Sets the branch on which a specific user-defined channel is mapped. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| SetCenterFrequency(string, double) | Sets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz. |
| SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) | Sets whether to detect the channels automatically or to use a specified channel configuration. |
| SetDigitalEdgeTriggerEdge(string, RFmxCdma2kMXDigitalEdgeTriggerEdge) | Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(string, RFmxCdma2kMXTriggerType) method to DigitalEdge. |
| SetDigitalEdgeTriggerSource(string, string) | Sets the source terminal for the digital edge trigger. This method is used only when you set the SetTriggerType(string, RFmxCdma2kMXTriggerType) method to DigitalEdge. |
| SetDownlinkSpreadingPNOffset(string, int) | Specified the PN offset in increments of 64 chips for forward link. |
| 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 the SetIQPowerEdgeTriggerLevelType(string, RFmxCdma2kMXIQPowerEdgeTriggerLevelType) method is set to Relative and in dBm when the IQ Power Edge Level Type method is set 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, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| SetIQPowerEdgeTriggerLevelType(string, RFmxCdma2kMXIQPowerEdgeTriggerLevelType) | Sets the reference for the IQ Power Edge Level Type method. This method is used only when you set the SetTriggerType(string, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| SetIQPowerEdgeTriggerSlope(string, RFmxCdma2kMXIQPowerEdgeTriggerSlope) | 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, RFmxCdma2kMXTriggerType) 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 SetTriggerType(string, RFmxCdma2kMXTriggerType) method to IQPowerEdge. |
| SetLimitedConfigurationChange(string, RFmxCdma2kMXLimitedConfigurationChange) | Sets the set of properties that are considered by RFmx in the locked signal configuration state. |
| SetLinkDirection(string, RFmxCdma2kMXLinkDirection) | Sets the link direction of the received signal. |
| SetNumberOfChannels(string, int) | Sets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined. |
| SetRadioConfiguration(string, RFmxCdma2kMXRadioConfiguration) | Sets the radio configuration for the channel. |
| 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 to wait before results are available. 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. |
| SetSelectedPorts(string, string) | Sets the instrument port to be configured to acquire a signal. Valid values |
| SetTriggerDelay(string, double) | Sets the trigger delay time. This value is expressed in seconds. |
| 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 SetIQPowerEdgeTriggerSlope(string, RFmxCdma2kMXIQPowerEdgeTriggerSlope) 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, RFmxCdma2kMXTriggerMinimumQuietTimeMode) | Sets whether the measurement computes the minimum quiet time used for triggering. |
| SetTriggerType(string, RFmxCdma2kMXTriggerType) | Sets the trigger type. |
| SetUplinkSpreadingLongCodeMask(string, long) | Sets the long code mask for reverse link spreading. |
| SetWalshCodeLength(string, int) | Sets the Walsh code length of a specific user-defined channel. This value is expressed in chips. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| SetWalshCodeNumber(string, int) | Sets the Walsh code number of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(string, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.Use "channel(n)" as the Selector Strings to configure or read this method. |
| WaitForMeasurementComplete(string, double) | Waits for the specified number of seconds for all the measurements to complete. |
| BuildChannelString(string, int) | Creates a selector string to use with channel configuration. |
| BuildOffsetString(string, int) | Creates the offset string to use as the selector string with the SEM and ACP offset configuration for fetch methods and methods. |
| BuildResultString(string) | Creates selector string for use with configuration or fetch. |