RFmx GSM DotNET

RFmxGsmMX Class

Download PDF

Updated2024-07-17
19 minute(s) read

RFmxGsmMX Class

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

Inheritance Hierarchy

SystemObject
NationalInstruments.RFmx.GsmMXRFmxGsmMX

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

Syntax

public sealed class RFmxGsmMX : ISignalConfiguration, 
	IDisposable

Public NotInheritable Class RFmxGsmMX
	Implements ISignalConfiguration, IDisposable

The RFmxGsmMX type exposes the following members.

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.

Top

Methods

	Name	Description
	AbortMeasurements	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	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. Query 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 help calculate an approximate setting for the reference level. The RFmxGSM Auto Level method performs 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 completing execution. You can also specify the starting reference level using the Auto Level Initial Reference Level method. Call this method after configuring all signal methods. When using NI 5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmx GSM 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.
	BuildOffsetString	Creates a offset string to use as the selector string with configuration or fetch methods and methods.
	BuildResultString	Creates selector string for use with configuration or fetch.
	BuildSlotString	Creates a slot string to use as the selector string with configuration or fetch methods and methods.
	CalculateFrequencyFromArfcn	Obsolete. Configures the center frequency from absolute RF channel number (ARFCN), band, and link direction.
	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. RFmxGSM commits settings to the hardware when you call the Initiate(String, String) method.
	ConfigureAutoTscDetectionEnabled	Configures whether to auto detect the training sequence code (TSC).
	ConfigureBand	Configures the band of operation.
	ConfigureBurstSynchronizationType	Configures the burst synchronization type.
	ConfigureDigitalEdgeTrigger	Configures the device to wait for a digital edge trigger and then marks a reference point within the record.
	ConfigureExternalAttenuation	Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer.
	ConfigureFrequency	Configures the center frequency of the RF signal to acquire.
	ConfigureFrequencyArfcn	Configures the center frequency from the absolute RF channel number (ARFCN), band, and the link direction.
	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.
	ConfigureLinkDirection	Configures the source of the signal to be measured.
	ConfigureNumberOfTimeslots	Configures the number of timeslots to be measured.
	ConfigurePowerControlLevel	Configures the power control level corresponding to the transmitted power. Use "slot(n)" as the selector string to configure this method.
	ConfigureReferenceLevel	Configures the reference level, which represents the maximum expected power of an RF input signal.
	ConfigureRF	Configures the RF methods of the signal specified by the selector string.
	ConfigureSignalType	Configures the signal type. Use "slot(n)" as the selector string to configure this method.
	ConfigureSoftwareEdgeTrigger	Configures the device to wait for a software trigger and then marks a reference point within the record.
	ConfigureTsc	Configures the training sequence code (TSC) in the burst. Use "slot(n)" as the selector string to configure this method.
	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.
	GetAttributeString	Gets the value of a of an RFmx string.
	GetAutoLevelInitialReferenceLevel	Gets the initial reference level the AutoLevel(String, Double, Double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.
	GetAutoTscDetectionEnabled	Gets whether the measurement automatically detects the training sequence code (TSC).
	GetBand	Gets the operation band.
	GetBurstSynchronizationType	Gets the method used to synchronize the burst.
	GetBurstType	Gets the burst type. Use "slot(n)" as the selector string to configure or read this method.
	GetCenterFrequency	Gets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.
	GetDigitalEdgeTriggerEdge	Gets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxGsmMXTriggerType) method to DigitalEdge.
	GetDigitalEdgeTriggerSource	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	Gets the latest error code and description.
	GetErrorString	Converts the status code returned by an RFmxGSM 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)
	GetHBFilterWidth	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	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	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	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	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	Gets the set of properties that are considered by RFmx in the locked signal configuration state.
	GetLinkDirection	Gets the source of the signal to be measured.
	GetModulationType	Gets the modulation scheme used for the signal. Use "slot(n)" as the selector string to configure or read this method.
	GetNumberOfTimeslots	Gets the number of time slots to be measured.
	GetPowerControlLevel	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	Gets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pk for baseband devices.
	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
	GetSignalStructure	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	Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.
	GetTriggerDelay	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	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	Gets whether the measurement computes the minimum quiet time used for triggering.
	GetTriggerType	Gets the trigger type.
	GetTsc	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.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	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. 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 to the default values. This method disables all the external attenuation tables in all calibration planes.
	SelectMeasurements	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. This method returns an error in the following situations: You configure an invalid trigger. You have not previously called the RFmxGSM 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.
	SetAttributeString	Sets the value of a String attribute.
	SetAutoLevelInitialReferenceLevel	Sets the initial reference level the AutoLevel(String, Double, Double) function uses to estimate the peak power of the input signal. This value is expressed in dBm.
	SetAutoTscDetectionEnabled	Sets whether the measurement automatically detects the training sequence code (TSC).
	SetBand	Sets the operation band.
	SetBurstSynchronizationType	Sets the method used to synchronize the burst.
	SetBurstType	Sets the burst type. Use "slot(n)" as the selector string to configure or read this method.
	SetCenterFrequency	Sets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.
	SetDigitalEdgeTriggerEdge	Sets the active edge for the trigger. This method is used only when you set the SetTriggerType(String, RFmxGsmMXTriggerType) method to DigitalEdge.
	SetDigitalEdgeTriggerSource	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	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	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	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	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	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	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	Sets the set of properties that are considered by RFmx in the locked signal configuration state.
	SetLinkDirection	Sets the source of the signal to be measured.
	SetModulationType	Sets the modulation scheme used for the signal. Use "slot(n)" as the selector string to configure or read this method.
	SetNumberOfTimeslots	Sets the number of time slots to be measured.
	SetPowerControlLevel	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	Sets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pk for baseband devices.
	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
	SetSignalStructure	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	Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.
	SetTriggerDelay	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	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	Sets whether the measurement computes the minimum quiet time used for triggering.
	SetTriggerType	Sets the trigger type.
	SetTsc	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.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WaitForMeasurementComplete	Waits for the specified number for seconds for all the measurements to complete.

Top

RFmx GSM DotNET

Table of Contents

RFmxGsmMX Class

Inheritance Hierarchy

Syntax

Properties

Methods

See Also

Reference

Log in to get a better experience