RFmx EVDO DotNET

Table of Contents

RFmxEvdoMX Methods

  • Updated2024-07-17
  • 20 minute(s) read
RFmxEvdoMX Methods

RFmxEvdoMX Methods

The RFmxEvdoMX type exposes the following members.

Methods

  NameDescription
Public methodAbortMeasurements
Stops acquisition and measurements associated with the signal instance that you specify in the selectorString parameter. These 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.
Public methodAnalyzeIQ1Waveform
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. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionType method value is either IQ or IQorSpectral.
Query the RFmxInstrMX.GetRecommendedAcquisitionType method after calling the RFmx EVDO Commit method.
Public methodAnalyzeSpectrum1Waveform
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.GetRecommendedAcquisitionType method value is either spectral or IQorSpectral.
Query the RFmxInstrMX.GetRecommendedAcquisitionType method after calling the RFmx EVDO Commit method.
Public methodAutoLevel
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 help calculate an approximate setting for the reference level.
The RFmxEVDO 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 RFmxEVDO 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.
Public methodStatic memberBuildCarrierString
Creates the carrier string to use as the selector string with the adjacent channel power (ACP), channel power (CHP), and spectral emission mask (SEM) carrier configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.
Public methodStatic memberBuildChannelString
Creates the channel string to use as the selector string with the modulation accuracy (ModAcc) channel configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.
Public methodStatic memberBuildOffsetString
Creates the offset string to use as the selector string with adjacent channel power (ACP) and spectral emission mask (SEM) offset configuration or fetch methods and methods.
Refer to the Selector String topic for information about the string syntax for named signals.
Public methodStatic memberBuildResultString
Creates selector string for use with configuration or fetch.
Public methodStatic memberCalculateFrequencyFromChannelNumber Obsolete.
Calculates the center frequency according to the EV-DO channel number.
Public methodCheckMeasurementStatus
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.
Public methodClearAllNamedResults
Clears all results for the current signal instance.
Public methodClearNamedResult
Clears a result instance specified by the result name in the selectorString parameter.
Public methodCloneSignalConfiguration
Creates a new instance of a signal by copying all the method values from an existing signal instance.
Public methodCommit
Commits settings to the hardware. Calling this method is optional. RFmxEVDO commits settings to the hardware when you call the Initiate(String, String) method.
Public methodConfigureBandClass
Configures the band class to be used for the measurement.
Public methodConfigureCarrierFrequency
Configures the carrier frequency of the selected carrier as an offset frequency relative to the center frequency. Use "carrier(n)" as the selector string to configure this method.
Configure the center frequency by using the ConfigureFrequency(String, Double) method. If the number of carriers is greater than 1, configure the number of carriers using the ConfigureNumberOfCarriers(String, Int32) method.
Public methodConfigureCarrierFrequencyArray
Configures the carrier frequency of the selected carriers as an offset frequency relative to the center frequency.
Configure the center frequency by using the ConfigureFrequency(String, Double) method. Configure the number of carriers using the ConfigureNumberOfCarriers(String, Int32) method.
Public methodConfigureChannelConfigurationMode
Configures RFmx EV-DO to detect the channels automatically or to use a specified channel configuration.
Public methodConfigureContiguousCarriers
Configures a number of contiguous carriers in a given band.
Public methodConfigureDigitalEdgeTrigger
Configures the device to wait for a digital edge trigger and then marks a reference point within the record.
Public methodConfigureExternalAttenuation
Specifies external attenuation to be considered by RFmx EV-DO measurements, such as the attenuation of a switch or cable connected to the signal analyzer RF IN connector.
Public methodConfigureFrequency
Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.
Public methodConfigureFrequencyChannelNumber
Configures the expected carrier frequency of the RF signal to acquire according to the given channel number. The signal analyzer tunes to this frequency.
Public methodConfigureIQPowerEdgeTrigger
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.
Public methodConfigureNumberOfCarriers
Configures the number of carriers for the analysis of the EV-DO signal.
Public methodConfigurePhysicalLayerSubtype
Configures the subtype of the EV-DO signal.
Public methodConfigureReferenceLevel
Configures the reference level. The reference level represents the maximum expected power of an input RF signal.
Public methodConfigureRF
Configures the RF methods of the signal specified by the selectorString parameter.
Public methodConfigureSoftwareEdgeTrigger
Configures the device to wait for a software trigger to mark a reference point within the record.
Public methodConfigureUplinkDataModulationType
Configures RFmx EV-DO to detect the channels automatically or to use a specified data modulation type.
Public methodConfigureUplinkNumberOfChannels
Configures the number of channels in the EV-DO uplink.
Public methodConfigureUplinkSpreading
Configures the spreading of the EV-DO uplink.
Public methodConfigureUplinkUserDefinedChannel
Configures a user defined channel in the EV-DO uplink specified by the selector string. Use "channel(n)" as the selector string to configure this method.
Public methodConfigureUplinkUserDefinedChannelArray
Configures the array of user defined channels in the EV-DO uplink.
Public methodDeleteSignalConfiguration
Deletes an instance of a signal.

Public methodDisableTrigger
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.
Public methodDispose
Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAllNamedResultNames
Returns all the named result names of the current signal instance.
Public methodGetAttributeBool
Gets the value of a Bool attribute.
Public methodGetAttributeDouble
Gets the value of a Double attribute.
Public methodGetAttributeInt
Gets the value of an RFmx 32-bit integer (int32) attribute.
Public methodGetAttributeString
Gets the value of a of an RFmx string.
Public methodGetAutoLevelInitialReferenceLevel
Gets the reference level at which the auto leveling process starts finding the optimal reference level. This value is expressed in dBm.
Public methodGetBandClass
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.
Public methodGetCarrierFrequency
Gets the carrier frequency of the RF signal to acquire. This value is expressed in Hz. The signal analyzer tunes to this frequency. Use "carrier(n)" as the Selector Strings to configure or read this method. The default value is 0.
Public methodGetCenterFrequency
Gets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.
Public methodGetChannelConfigurationMode
Gets whether to detect the channels automatically or to use a specified channel configuration.
Public methodGetDigitalEdgeTriggerEdge
Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to DigitalEdge.
Public methodGetDigitalEdgeTriggerSource
Gets the source terminal for the digital edge trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to DigitalEdge.
Public methodGetErrorString
Converts the status code returned by an RFmxEVDO function into a string.
Public methodGetExternalAttenuation
Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIQPowerEdgeTriggerLevel
Gets the power level at which the device triggers. This value is expressed in dB when the SetIQPowerEdgeTriggerLevelType(String, RFmxEvdoMXIQPowerEdgeTriggerLevelType) 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, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodGetIQPowerEdgeTriggerLevelType
Gets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodGetIQPowerEdgeTriggerSlope
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, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodGetIQPowerEdgeTriggerSource
Gets the channel from which the device monitors the trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodGetLimitedConfigurationChange
Gets the set of properties that are considered by RFmx in the locked signal configuration state.
Public methodGetNumberOfCarriers
Gets the number of carriers in the signal.
Public methodGetPhysicalLayerSubtype
Selects the EV-DO physical layer subtype.
Public methodGetReferenceLevel
Gets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodGetReferenceLevelHeadroom
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.

Public methodGetResultFetchTimeout
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.
Public methodGetSelectedPorts
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

Public methodGetTriggerDelay
Gets the trigger delay time. This value is expressed in seconds.
Public methodGetTriggerMinimumQuietTimeDuration
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, RFmxEvdoMXIQPowerEdgeTriggerSlope) 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.
Public methodGetTriggerMinimumQuietTimeMode
Gets whether the measurement computes the minimum quiet time used for triggering.
Public methodGetTriggerType
Gets the trigger type.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUplinkBranch
Gets the quadrature branch on which a specific user defined-channel is mapped. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodGetUplinkDataModulationType
Defines the modulation of the data channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined.
Public methodGetUplinkNumberOfChannels
Gets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined.
Public methodGetUplinkSpreadingIMask
Gets the long code mask of the in-phase (I) channel. The default value is 0x0.
Public methodGetUplinkSpreadingQMask
Gets the long code mask of the quadrature (Q) channel. The default value is 0x0.
Public methodGetUplinkWalshCodeLength
Gets the Walsh Code Length of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodGetUplinkWalshCodeNumber
Gets the Walsh Code Number of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodGetWarning
Gets the latest warning code and description.
Public methodInitiate
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 CheckMeasurementStatus(String, Boolean) method.
Public methodResetAttribute
Resets the attribute to its default value.
Public methodResetToDefault
Resets a signal to the default values.
Public methodSelectMeasurements
Specifies the measurements that you want to enable.
Public methodSendSoftwareEdgeTrigger
Sends a trigger to the device when you use the RFmxEVDO_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 RFmxEvdoMX.Initiate method.
Public methodSetAttributeBool
Sets the value of a Bool attribute.
Public methodSetAttributeDouble
Sets the value of a Double attribute.
Public methodSetAttributeInt
Sets the value of a Int attribute.
Public methodSetAttributeString
Sets the value of a String attribute.
Public methodSetAutoLevelInitialReferenceLevel
Sets the reference level at which the auto leveling process starts finding the optimal reference level. This value is expressed in dBm.
Public methodSetBandClass
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.
Public methodSetCarrierFrequency
Sets the carrier frequency of the RF signal to acquire. This value is expressed in Hz. The signal analyzer tunes to this frequency. Use "carrier(n)" as the Selector Strings to configure or read this method. The default value is 0.
Public methodSetCenterFrequency
Sets the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz.
Public methodSetChannelConfigurationMode
Sets whether to detect the channels automatically or to use a specified channel configuration.
Public methodSetDigitalEdgeTriggerEdge
Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to DigitalEdge.
Public methodSetDigitalEdgeTriggerSource
Sets the source terminal for the digital edge trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to DigitalEdge.
Public methodSetExternalAttenuation
Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB.
Public methodSetIQPowerEdgeTriggerLevel
Sets the power level at which the device triggers. This value is expressed in dB when the SetIQPowerEdgeTriggerLevelType(String, RFmxEvdoMXIQPowerEdgeTriggerLevelType) 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, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodSetIQPowerEdgeTriggerLevelType
Sets the reference for the SetIQPowerEdgeTriggerLevel(String, Double) method. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodSetIQPowerEdgeTriggerSlope
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, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodSetIQPowerEdgeTriggerSource
Sets the channel from which the device monitors the trigger. This method is used only when you set the SetTriggerType(String, RFmxEvdoMXTriggerType) method to IQPowerEdge.
Public methodSetLimitedConfigurationChange
Sets the set of properties that are considered by RFmx in the locked signal configuration state.
Public methodSetNumberOfCarriers
Sets the number of carriers in the signal.
Public methodSetPhysicalLayerSubtype
Selects the EV-DO physical layer subtype.
Public methodSetReferenceLevel
Sets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.
Public methodSetReferenceLevelHeadroom
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.

Public methodSetResultFetchTimeout
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.
Public methodSetSelectedPorts
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

Public methodSetTriggerDelay
Sets the trigger delay time. This value is expressed in seconds.
Public methodSetTriggerMinimumQuietTimeDuration
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, RFmxEvdoMXIQPowerEdgeTriggerSlope) 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.
Public methodSetTriggerMinimumQuietTimeMode
Sets whether the measurement computes the minimum quiet time used for triggering.
Public methodSetTriggerType
Sets the trigger type.
Public methodSetUplinkBranch
Sets the quadrature branch on which a specific user defined-channel is mapped. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodSetUplinkDataModulationType
Defines the modulation of the data channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined.
Public methodSetUplinkNumberOfChannels
Sets the number of user-defined channels. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined.
Public methodSetUplinkSpreadingIMask
Sets the long code mask of the in-phase (I) channel. The default value is 0x0.
Public methodSetUplinkSpreadingQMask
Sets the long code mask of the quadrature (Q) channel. The default value is 0x0.
Public methodSetUplinkWalshCodeLength
Sets the Walsh Code Length of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodSetUplinkWalshCodeNumber
Sets the Walsh Code Number of a specific user-defined channel. This method is used only when you set the SetChannelConfigurationMode(String, RFmxEvdoMXChannelConfigurationMode) method to UserDefined. Use "channel(n)" as the Selector Strings to configure or read this method.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWaitForMeasurementComplete
Waits for the specified number for seconds for all the measurements to complete.
Top

See Also

Log in to get a better experience