RFmxCdma2kMX Class

Download PDF

Updated2024-07-17
20 minute(s) read

RFmxCdma2kMX Class

Defines a root class which is used to identify and control CDMA2k signal configuration.

Inheritance Hierarchy

SystemObject
NationalInstruments.RFmx.Cdma2kMXRFmxCdma2kMX

Namespace: NationalInstruments.RFmx.Cdma2kMX
Assembly: NationalInstruments.RFmx.Cdma2kMX.Fx40 (in NationalInstruments.RFmx.Cdma2kMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)

Syntax

public sealed class RFmxCdma2kMX : ISignalConfiguration, 
	IDisposable

Public NotInheritable Class RFmxCdma2kMX
	Implements ISignalConfiguration, IDisposable

The RFmxCdma2kMX type exposes the following members.

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.

Top

Methods

	Name	Description
	AbortMeasurements	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. 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	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. Query the Recommended Acquisition Type method after calling the Commit(String) method.
	AnalyzeSpectrum1Waveform	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. Query the the RFmxInstrMX.GetRecommendedAcquisitionType method after calling the Commit(String) method.
	AutoLevel	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 RFmxCDMA2k Auto Level method does the following tasks: Resets the mixer level, mixer level offset, and IF output power offset. 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. Iterates to adjust the reference level based on the input signal peak power. 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 RFmxCDMA2k 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.
	BuildChannelString	Creates a selector string to use with channel configuration. Refer to the Selector String topic for information about the string syntax for named signals.
	BuildOffsetString	Creates the offset string to use as the selector string with the SEM and ACP offset configuration for fetch methods and methods. Refer to the Selector String topic for information about the string syntax for named signals.
	BuildResultString	Creates selector string for use with configuration or fetch.
	CalculateFrequencyFromChannelNumber	Obsolete. Calculates the center frequency according to the CDMA2k channel number.
	CheckMeasurementStatus	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	Clears all results for the current signal instance.
	ClearNamedResult	Clears a result instance specified by the result name in the selectorString parameter.
	CloneSignalConfiguration	Creates a new instance of a signal by copying all the method values from an existing signal instance.
	Commit	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	Configures the band class used for the measurement.
	ConfigureChannelConfigurationMode	Configures RFmx CDMA2k to detect the channels automatically or to use a specified channel configuration.
	ConfigureDigitalEdgeTrigger	Configures the device to wait for a digital edge trigger and then marks a reference point within the record.
	ConfigureExternalAttenuation	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	Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.
	ConfigureFrequencyChannelNumber(String, RFmxCdma2kMXLinkDirection, Int32, Int32)	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, Int32, Int32, Int32)	Obsolete. 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	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	Configures the number of channels for the user-defined channel configuration when you set the SetChannelConfigurationMode(String, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.
	ConfigureRadioConfiguration	Configures the radio configuration of the CDMA2k signal.
	ConfigureReferenceLevel	Configures the reference level. The reference level represents the maximum expected power of an input RF signal.
	ConfigureRF	Configures the RF methods of the signal specified by the selectorString parameter.
	ConfigureSoftwareEdgeTrigger	Configures the device to wait for a software trigger and then marks a reference point within the record.
	ConfigureUplinkSpreading	Configures the scrambling code used for the uplink transmission.
	ConfigureUserDefinedChannel	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 is defined by the Walsh code length and number and the quadrature branch on which it is mapped.
	ConfigureUserDefinedChannelArray	Configures all user-defined channels when you set the SetChannelConfigurationMode(String, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined. Use equal-sized arrays for walshCodeLength, walshCodeNumber, and branch.
	DeleteSignalConfiguration	Deletes an instance of a signal.
	DisableTrigger	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.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object)
	GetAllNamedResultNames	Returns all the named result names of the current signal instance.
	GetAttributeBool	Gets the value of a Bool attribute.
	GetAttributeDouble	Gets the value of a Double attribute.
	GetAttributeInt	Gets the value of an RFmx 32-bit integer (int32) attribute.
	GetAttributeLong	Gets the value of an RFmx 64-bit integer (int64) attribute.
	GetAttributeString	Gets the value of a of an RFmx string.
	GetAutoLevelInitialReferenceLevel	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.The default value is 30 dBm.
	GetBandClass	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	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	Gets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.
	GetChannelConfigurationMode	Gets whether to detect the channels automatically or to use a specified channel configuration.
	GetDigitalEdgeTriggerEdge	Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxCdma2kMXTriggerType) method to DigitalEdge.
	GetDigitalEdgeTriggerSource	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	Specified the PN offset in increments of 64 chips for forward link.
	GetErrorString	Converts the status code returned by an RFmxCDMA2k function into a string.
	GetExternalAttenuation	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.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
	GetIQPowerEdgeTriggerLevel	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	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	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	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	Gets the set of properties that are considered by RFmx in the locked signal configuration state.
	GetLinkDirection	Gets the link direction of the received signal.
	GetNumberOfChannels	Gets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.
	GetRadioConfiguration	Gets the radio configuration for the channel.
	GetReferenceLevel	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 V_pk-pk for baseband devices.
	GetReferenceLevelHeadroom	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.
	GetResultFetchTimeout	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	Gets the instrument port to be configured to acquire a signal. 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
	GetTriggerDelay	Gets the trigger delay time. This value is expressed in seconds.
	GetTriggerMinimumQuietTimeDuration	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	Gets whether the measurement computes the minimum quiet time used for triggering.
	GetTriggerType	Gets the trigger type.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetUplinkSpreadingLongCodeMask	Gets the long code mask for reverse link spreading.
	GetWalshCodeLength	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	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	Gets the latest warning code and description.
	Initiate	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.
	ResetAttribute	Resets the attribute to its default value.
	ResetToDefault	Resets a signal configuration to the default values.
	SelectMeasurements	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. This method returns an error in the following situations: You configure an invalid trigger. You have not previously called the RFmxCdma2kMX.Initiate method.
	SetAttributeBool	Sets the value of a Bool attribute.
	SetAttributeDouble	Sets the value of a Double attribute.
	SetAttributeInt	Sets the value of a Int attribute.
	SetAttributeLong	Sets the value of a Long attribute.
	SetAttributeString	Sets the value of a String attribute.
	SetAutoLevelInitialReferenceLevel	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.The default value is 30 dBm.
	SetBandClass	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	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	Sets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.
	SetChannelConfigurationMode	Sets whether to detect the channels automatically or to use a specified channel configuration.
	SetDigitalEdgeTriggerEdge	Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxCdma2kMXTriggerType) method to DigitalEdge.
	SetDigitalEdgeTriggerSource	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	Specified the PN offset in increments of 64 chips for forward link.
	SetExternalAttenuation	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	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	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	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	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	Sets the set of properties that are considered by RFmx in the locked signal configuration state.
	SetLinkDirection	Sets the link direction of the received signal.
	SetNumberOfChannels	Sets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxCdma2kMXChannelConfigurationMode) method to UserDefined.
	SetRadioConfiguration	Sets the radio configuration for the channel.
	SetReferenceLevel	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 V_pk-pk for baseband devices.
	SetReferenceLevelHeadroom	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.
	SetResultFetchTimeout	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	Sets the instrument port to be configured to acquire a signal. 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
	SetTriggerDelay	Sets the trigger delay time. This value is expressed in seconds.
	SetTriggerMinimumQuietTimeDuration	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	Sets whether the measurement computes the minimum quiet time used for triggering.
	SetTriggerType	Sets the trigger type.
	SetUplinkSpreadingLongCodeMask	Sets the long code mask for reverse link spreading.
	SetWalshCodeLength	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	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.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WaitForMeasurementComplete	Waits for the specified number of seconds for all the measurements to complete.

Top

RFmx CDMA2K DotNET

Table of Contents

RFmxCdma2kMX Class

Inheritance Hierarchy

Syntax

Properties

Methods

See Also

Reference

Log in to get a better experience