RFmxGsmMX Class
- Updated2025-10-13
- 12 minute(s) read
Defines a root class which is used to identify and control GSM signal configuration.
Derives from
- ISignalConfiguration
- IDisposable
Syntax
Namespace: NationalInstruments.RFmx.GsmMX
public class RFmxGsmMX : ISignalConfiguration, IDisposable
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that indicates whether the signal has been disposed. |
| ModAcc | Gets the RFmxGsmMXModAcc instance that represents the ModAcc measurement. |
| Orfs | Gets the RFmxGsmMXOrfs instance that represents the ORFS measurement. |
| Pvt | Gets the RFmxGsmMXPvt instance that represents the PVT measurement. |
| SignalConfigurationName | Gets the signal configuration name. |
| SignalConfigurationType | Gets the Type object for RFmxGsmMX. |
Methods
| Name | Description |
|---|---|
| AbortMeasurements(string) | Stops acquisition and measurements associated with the signal instance that you specify in the selectorString parameter. This acquisition and measurements were previously initiated by the Initiate(string, string) method. 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(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. Use this method only if the RFmxInstrMX.GetRecommendedAcquisitionType method value is IQ. |
| 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 help 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 RFmxGsmMX) | 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. RFmxGSM commits settings to the hardware when you call the Initiate(string, string) method. |
| ConfigureAutoTscDetectionEnabled(string, RFmxGsmMXAutoTscDetectionEnabled) | Configures whether to auto detect the training sequence code (TSC). |
| ConfigureBand(string, RFmxGsmMXBand) | Configures the band of operation. |
| ConfigureBurstSynchronizationType(string, RFmxGsmMXBurstSynchronizationType) | Configures the burst synchronization type. |
| ConfigureDigitalEdgeTrigger(string, string, RFmxGsmMXDigitalEdgeTriggerEdge, 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 the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. |
| ConfigureFrequency(string, double) | Configures the center frequency of the RF signal to acquire. |
| ConfigureFrequencyArfcn(string, RFmxGsmMXLinkDirection, RFmxGsmMXBand, int) | Configures the center frequency from the absolute RF channel number (ARFCN), band, and the link direction. |
| ConfigureIQPowerEdgeTrigger(string, string, RFmxGsmMXIQPowerEdgeTriggerSlope, double, double, RFmxGsmMXTriggerMinimumQuietTimeMode, double, RFmxGsmMXIQPowerEdgeTriggerLevelType, 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. |
| ConfigureLinkDirection(string, RFmxGsmMXLinkDirection) | Configures the source of the signal to be measured. |
| ConfigureNumberOfTimeslots(string, int) | Configures the number of timeslots to be measured. |
| ConfigurePowerControlLevel(string, int) | Configures the power control level corresponding to the transmitted power. |
| ConfigureReferenceLevel(string, double) | Configures the reference level, which represents the maximum expected power of an RF input signal. |
| ConfigureRF(string, double, double, double) | Configures the RF methods of the signal specified by the selector string. |
| ConfigureSignalType(string, RFmxGsmMXModulationType, RFmxGsmMXBurstType, RFmxGsmMXHBFilterWidth) | Configures the signal type. |
| ConfigureSoftwareEdgeTrigger(string, double, bool) | Configures the device to wait for a software trigger and then marks a reference point within the record. |
| ConfigureTsc(string, RFmxGsmMXTsc) | Configures the training sequence code (TSC) in the burst. |
| 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. |
| GetAttributeString(string, int, out string) | Gets the value of a of an RFmx string. |
| GetAutoLevelInitialReferenceLevel(string, out double) | Gets the initial reference level the AutoLevel(string, double, out double) function uses to estimate the peak power of the input signal. This value is expressed in dBm. |
| GetAutoTscDetectionEnabled(string, out RFmxGsmMXAutoTscDetectionEnabled) | Gets whether the measurement automatically detects the training sequence code (TSC). |
| GetBand(string, out RFmxGsmMXBand) | Gets the operation band. |
| GetBurstSynchronizationType(string, out RFmxGsmMXBurstSynchronizationType) | Gets the method used to synchronize the burst. |
| GetBurstType(string, out RFmxGsmMXBurstType) | Gets the burst type. Use "slot(n)" as the selector string to configure or read this method. |
| GetCenterFrequency(string, out double) | Gets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency. |
| GetDigitalEdgeTriggerEdge(string, out RFmxGsmMXDigitalEdgeTriggerEdge) | Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) 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, RFmxGsmMXTriggerType) method to DigitalEdge. |
| GetError(out int, out string) | Gets the latest error code and description. |
| GetErrorString(int, out string) | Converts the status code returned by an RFmxGSM 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. |
| GetHBFilterWidth(string, out RFmxGsmMXHBFilterWidth) | Gets the filter width when you set the SetBurstType(string, RFmxGsmMXBurstType) method to HB. Use "slot(n)" as the selector string to configure or read this method. |
| GetIQPowerEdgeTriggerLevel(string, out double) | Gets the power level at which the device triggers. This value is expressed in dB when you set the SetIQPowerEdgeTriggerLevelType(string, RFmxGsmMXIQPowerEdgeTriggerLevelType) method to Relative and in dBm when you set the IQ Power Edge Level Type method to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| GetIQPowerEdgeTriggerLevelType(string, out RFmxGsmMXIQPowerEdgeTriggerLevelType) | Gets the reference for the SetIQPowerEdgeTriggerLevel(string, double) method. The IQ Power Edge Level Type method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| GetIQPowerEdgeTriggerSlope(string, out RFmxGsmMXIQPowerEdgeTriggerSlope) | 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 level that you specify in the SetIQPowerEdgeTriggerLevel(string, double) method with the slope you specify. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) 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, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| GetLimitedConfigurationChange(string, out RFmxGsmMXLimitedConfigurationChange) | Gets the set of properties that are considered by RFmx in the locked signal configuration state. |
| GetLinkDirection(string, out RFmxGsmMXLinkDirection) | Gets the source of the signal to be measured. |
| GetModulationType(string, out RFmxGsmMXModulationType) | Gets the modulation scheme used for the signal. Use "slot(n)" as the selector string to configure or read this method. |
| GetNumberOfTimeslots(string, out int) | Gets the number of time slots to be measured. |
| GetPowerControlLevel(string, out int) | Gets the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications. Use "slot(n)" as the selector string to configure or read this method. |
| GetReferenceLevel(string, out double) | 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. |
| 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 |
| GetSignalStructure(string, out RFmxGsmMXSignalStructure) | Gets whether the signal is bursted or continuous. For bursted signal and continuous signals, set the SetTriggerType(string, RFmxGsmMXTriggerType) to IQPowerEdge and None, respectively. |
| GetTimingAdvance(string, out int) | Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst. |
| GetTriggerDelay(string, out double) | Gets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. |
| 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, RFmxGsmMXIQPowerEdgeTriggerSlope) 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 RFmxGsmMXTriggerMinimumQuietTimeMode) | Gets whether the measurement computes the minimum quiet time used for triggering. |
| GetTriggerType(string, out RFmxGsmMXTriggerType) | Gets the trigger type. |
| GetTsc(string, out RFmxGsmMXTsc) | Gets the training sequence code (TSC) to use. This method is applicable only when you set the SetBurstSynchronizationType(string, RFmxGsmMXBurstSynchronizationType) method to Tsc and the SetAutoTscDetectionEnabled(string, RFmxGsmMXAutoTscDetectionEnabled) method to False. For access burst Tsc0, Tsc1, and Tsc2 are applicable. Use "slot(n)" as the selector string 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. 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, out bool) method. |
| ResetAttribute(string, RFmxGsmMXPropertyId) | Resets the attribute to its default value. |
| ResetToDefault(string) | Resets a signal to the default values. This method disables all the external attenuation tables in all calibration planes. |
| SelectMeasurements(string, RFmxGsmMXMeasurementTypes, bool) | Specifies the measurements that you want to enable. |
| SendSoftwareEdgeTrigger() | Sends a trigger to the device when you use the RFmxGSM_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. |
| SetAttributeString(string, int, string) | Sets the value of a String attribute. |
| SetAutoLevelInitialReferenceLevel(string, double) | Sets the initial reference level the AutoLevel(string, double, out double) function uses to estimate the peak power of the input signal. This value is expressed in dBm. |
| SetAutoTscDetectionEnabled(string, RFmxGsmMXAutoTscDetectionEnabled) | Sets whether the measurement automatically detects the training sequence code (TSC). |
| SetBand(string, RFmxGsmMXBand) | Sets the operation band. |
| SetBurstSynchronizationType(string, RFmxGsmMXBurstSynchronizationType) | Sets the method used to synchronize the burst. |
| SetBurstType(string, RFmxGsmMXBurstType) | Sets the burst type. Use "slot(n)" as the selector string to configure or read this method. |
| SetCenterFrequency(string, double) | Sets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency. |
| SetDigitalEdgeTriggerEdge(string, RFmxGsmMXDigitalEdgeTriggerEdge) | Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) 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, RFmxGsmMXTriggerType) method to DigitalEdge. |
| 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. |
| SetHBFilterWidth(string, RFmxGsmMXHBFilterWidth) | Sets the filter width when you set the SetBurstType(string, RFmxGsmMXBurstType) method to HB. Use "slot(n)" as the selector string to configure or read this method. |
| SetIQPowerEdgeTriggerLevel(string, double) | Sets the power level at which the device triggers. This value is expressed in dB when you set the SetIQPowerEdgeTriggerLevelType(string, RFmxGsmMXIQPowerEdgeTriggerLevelType) method to Relative and in dBm when you set the IQ Power Edge Level Type method to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this method, taking into consideration the specified slope. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| SetIQPowerEdgeTriggerLevelType(string, RFmxGsmMXIQPowerEdgeTriggerLevelType) | Sets the reference for the SetIQPowerEdgeTriggerLevel(string, double) method. The IQ Power Edge Level Type method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| SetIQPowerEdgeTriggerSlope(string, RFmxGsmMXIQPowerEdgeTriggerSlope) | 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 level that you specify in the SetIQPowerEdgeTriggerLevel(string, double) method with the slope you specify. This method is used only when you set the SetTriggerType(string, RFmxGsmMXTriggerType) 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, RFmxGsmMXTriggerType) method to IQPowerEdge. |
| SetLimitedConfigurationChange(string, RFmxGsmMXLimitedConfigurationChange) | Sets the set of properties that are considered by RFmx in the locked signal configuration state. |
| SetLinkDirection(string, RFmxGsmMXLinkDirection) | Sets the source of the signal to be measured. |
| SetModulationType(string, RFmxGsmMXModulationType) | Sets the modulation scheme used for the signal. Use "slot(n)" as the selector string to configure or read this method. |
| SetNumberOfTimeslots(string, int) | Sets the number of time slots to be measured. |
| SetPowerControlLevel(string, int) | Sets the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications. Use "slot(n)" as the selector string to configure or read this method. |
| SetReferenceLevel(string, double) | 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. |
| 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 |
| SetSignalStructure(string, RFmxGsmMXSignalStructure) | Sets whether the signal is bursted or continuous. For bursted signal and continuous signals, set the SetTriggerType(string, RFmxGsmMXTriggerType) to IQPowerEdge and None, respectively. |
| SetTimingAdvance(string, int) | Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst. |
| SetTriggerDelay(string, double) | Sets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. |
| 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, RFmxGsmMXIQPowerEdgeTriggerSlope) 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, RFmxGsmMXTriggerMinimumQuietTimeMode) | Sets whether the measurement computes the minimum quiet time used for triggering. |
| SetTriggerType(string, RFmxGsmMXTriggerType) | Sets the trigger type. |
| SetTsc(string, RFmxGsmMXTsc) | Sets the training sequence code (TSC) to use. This method is applicable only when you set the SetBurstSynchronizationType(string, RFmxGsmMXBurstSynchronizationType) method to Tsc and the SetAutoTscDetectionEnabled(string, RFmxGsmMXAutoTscDetectionEnabled) method to False. For access burst Tsc0, Tsc1, and Tsc2 are applicable. Use "slot(n)" as the selector string to configure or read this method. |
| WaitForMeasurementComplete(string, double) | Waits for the specified number for seconds for all the measurements to complete. |
| BuildOffsetString(string, int) | Creates a offset string to use as the selector string with configuration or fetch methods and methods. |
| BuildResultString(string) | Creates selector string for use with configuration or fetch. |
| BuildSlotString(string, int) | Creates a slot string to use as the selector string with configuration or fetch methods and methods. |