Keysight Pathwave 89600 VSA .NET API
MeasurementExtension Class Members
See Also  Properties  Methods  Events
Agilent.SA.Vsa.CustomOfdm.Interfaces Assembly > Agilent.SA.Vsa.CustomOfdm Namespace : MeasurementExtension Class

Glossary Item Box

The following tables list the members exposed by MeasurementExtension.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyAllDataStreamsActiveGets or sets a value indicating whether all Data type allocations within the SetResourceMap are assumed to be active on all MIMO antenna associated data streams.  28.40
Public PropertyAntennaDetectionThresholdGets or sets a value indicating the power threshold in dB relative to the max power of all available MIMO paths used for detecting whether an antenna port is active on an input channel for this PDSCH.  29.00
Public PropertyCrossCorrelatedEvmEnabledGets or sets a value indicating whether to compute cross-correlated EVM between two measurement channels.  27.40
Public PropertyEnableHalfSubcarrierShiftGets or sets a value indicating whether to enable the half subcarrier shift.  22.20
Public PropertyEqualizerModeGets or sets the averaging mode used when averaging the equalizer across multiple symbols.  
Public PropertyExtendedFrequencyLockRangeWidthGets or sets the center frequency lock range.  
Public PropertyFbmcSettingsGets the FBMC settings object.  21.00
Public PropertyFftLengthGets or sets the OFDM FFT length.  
Public PropertyFrameCreationUtilityGets the frame creation utility.  27.40
Public PropertyGuardIntervalGets or sets the cyclic prefix guard interval of the signal, as a fraction of the IFFT time length.  
Public PropertyGuardIntervalPerSymbolGets or sets the cyclic prefix guard interval of each OFDM symbol, as a fraction of the IFFT time length.  21.00
Public PropertyGuardIntervalRepeatIndexGets or sets how to loop back if the end of the specified cyclic prefix/suffix guard interval property arrays is reached.  21.00
Public PropertyGuardLowerSubcarriersGets or sets the number guard subcarriers below the used subcarriers.  
Public PropertyGuardUpperSubcarriersGets or sets the number guard subcarriers above the used subcarriers.  
Public PropertyInitialEqualizerModeGets or sets the Mode for initial equalizer construction.  21.00
Public PropertyInitialEqualizerSymbolsGets or sets a value indicating the number of symbols to use when initial equalizer mode is Manual.  21.00
Public PropertyIsDataSubcarriersDisplayedGets or sets a value indicating whether data subcarriers are displayed in IQ traces.  
Public PropertyIsDisplayColorByUserGets or sets a value indicating whether coloring of IQ traces is based on user ID.  
Public PropertyIsDisplayEvmInPercentGets or sets a value indicating whether EVM values are displayed as percentages.  
Public PropertyIsDisplaySyncCorrelationInPercentGets or sets a value indicating whether the sync correlation value is displayed as a percentage.  
Public PropertyIsDisposedGets a value indicating whether the object has been disposed. If an object has been disposed any attempt to use it will lead to an ObjectDisposedException being thrown. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public PropertyIsEqualizerUseDataGets or sets a value indicating whether data subcarriers are included when training the equalizer.  
Public PropertyIsEqualizerUseDCPilotGets or sets a value indicating whether a pilot subcarrier at DC is used for channel estimation.  14.00
Public PropertyIsEqualizerUsePilotsGets or sets a value indicating whether pilot subcarriers are included when training the equalizer.  
Public PropertyIsEqualizerUsePreambleGets or sets a value indicating whether preamble subcarriers are included when training the equalizer.  
Public PropertyIsEvmNormalizeByReferenceGets or sets a value indicating whether EVM values are normalized by the reference power level.  
Public PropertyIsExtendedFrequencyLockRangeGets or sets a value indicating whether to enable extended frequency lock range.  
Public PropertyIsFrequencyMirroredGets or sets a value indicating whether the modulated signal has frequencies inverted.  
Public PropertyIsNormalizedGets or sets a value indicating whether to normalize IQ traces.  
Public PropertyIsNullSubcarriersDisplayedGets or sets a value indicating whether null subcarriers are displayed in IQ traces.  
Public PropertyIsOfdmErrorVectorBeforeIdftDespreadGets or sets a value indicating whether the OFDM error vector is before IDFT despread.  28.60
Public PropertyIsPilotDefinedInTimeDomainGets or sets a value indicating whether the pilot is defined in time domain.  28.40
Public PropertyIsPilotSubcarriersDisplayedGets or sets a value indicating whether pilot subcarriers are displayed in IQ traces.  
Public PropertyIsPreambleSubcarriersDisplayedGets or sets a value indicating whether preamble subcarriers are displayed in IQ traces.  
Public PropertyIsPulsedSignalGets or sets a value indicating whether the input signal is a pulsed (bursted) signal.  
Public PropertyIsPulseSearchEnabledGets or sets a value indicating whether the analyzer searches for an RF pulse (burst) to analyze.  
Public PropertyIsPulseSearchThresholdAutomaticGets or sets a value indicating whether the pulse search threshold is automatically determined.  
Public PropertyIsSampleClockCompensatedGets or sets a value indicating whether symbol clock error should be compensated.  21.00
Public PropertyIsTrackAmplitudeGets or sets a value indicating whether pilot tracking tracks the average pilot amplitude.  
Public PropertyIsTrackDataSubcarriersGets or sets a value indicating whether tracking operations include data subcarriers.  
Public PropertyIsTrackPhaseGets or sets a value indicating whether pilot tracking tracks the average pilot phase.  
Public PropertyIsTrackTimingGets or sets a value indicating whether pilot tracking tracks average pilot symbol timing.  
Public PropertyMeasurementIntervalGets or sets the portion of the ResultLength to analyze.  
Public PropertyMeasurementOffsetGets or sets the offset of analyzed portion of ResultLength.  
Public PropertyModulationSchemeGets or sets the modulation scheme for the analyzed signal.  21.00
Public PropertyMulticarrierFilterGets the multi-carrier filter settings object.  21.00
Public PropertyMultipleAccessSchemeGets or sets the multiple-access scheme for the analyzed signal.  21.00
Public PropertyNamePerUserGets or sets the comma-separated list of names for each user ID in the resource map.  29.00
Public PropertyNomaSettingsGets the NOMA settings object.  21.00
Public PropertyOfdmSystemSampleFrequencyGets or sets the fundamental OFDM sampling frequency.  
Public PropertyPerUserStreamResultsEnabledGets or sets a value indicating whether per user ID active port stream results are included within OFDM Data Burst Info trace results.  29.00
Public PropertyPilotValuesGets or sets the array of reference pilot IQ values.  
Public PropertyPreambleValuesGets or sets the array of reference preamble IQ values.  
Public PropertyPulseSearchThresholdGets or sets the threshold for pulse search.  
Public PropertyQamIdentifierBoostLevelsGets or sets the array of power boost levels for each QAM Identifier.  
Public PropertyQamIdentifiersGets or sets the array of QAM identifier values.  
Public PropertyQamLevelsGets or sets the array of possible QAM constellation types.  
Public PropertyResourceInterfaceGets or sets the resource interface selection which determines the set of API properties used to describe the OFDM signal to be analyzed. This includes the mapping of frame part allocations to the available OFDM Resource Units (RU) plus describing each individual frame part allocation's associated configuration properties.  29.00
Public PropertyResourceMapGets or sets the array specifying the type of each subcarrier and symbol time resource within the signal.  
Public PropertyResourceModulationGets or sets an array specifying the modulation format of each subcarrier and symbol time in the signal.  
Public PropertyResourceRepeatIndexGets or sets how to loop back if the end of ResourceMap or ResourceModulation is reached.  
Public PropertyResultLengthGets or sets the total number of symbols to analyze.  
Public PropertyResultLengthSelectionGets or sets how result length is determined.  
Public PropertyScmaSettingsGets the SCMA settings object.  21.00
Public PropertySearchLengthGets or sets how much data is acquired from the input hardware.  
Public PropertySymbolPhaseCompensationFrequencyGets or sets the frequency in hertz used for symbol phase compensation of the signal under test.  28.40
Public PropertySymbolPhaseCompensationSourceGets or sets the frequency origin to use for symbol phase compensation.  28.40
Public PropertySymbolTimeAdjustmentGets or sets the IFFT start offset within the total OFDM symbol time.  
Public PropertySynchronizationAntennaPortIndexGets or sets a value indicating the index of antenna port which is used for synchronization.  27.40
Public PropertySynchronizationMeasurementChannelIndexGets or sets a value indicating the index of the input channel which is used for synchronization.  27.40
Public PropertySynchronizationModeGets or sets how the analyzer synchronizes to the measured signal.  
Public PropertySynchronizationReferenceIntervalGets or sets the interval of the reference signal to use for synchronization (in symbols).  18.0
Public PropertySynchronizationReferenceOffsetGets or sets the offset of the reference signal to use for synchronization (in symbols).  18.0
Public PropertySynchronizationRegionSelectionGets or sets how the analyzer defines synchronization region.  18.0
Public PropertySynchronizationSearchIntervalGets or sets the search interval for synchronization (in symbols).  18.0
Public PropertySynchronizationSearchOffsetGets or sets the search offset for synchronization (in symbols).  18.0
Public PropertyTimeGapsGets or sets the time gap before each OFDM symbol, defined in samples at the OFDM system sample frequency.  21.00
Public PropertyTimeGapsRepeatIndexGets or sets how to loop back if the end of the SetTimeGapPerSymbol array is reached.  21.00
Public PropertyTransmitterAntennasGets or sets the number of transmitter antennas for the measurement.  
Public PropertyTransmitterWindowBetaGets or sets the time-domain windowing between symbols.  
Public PropertyUnknownPilotBoostLevelGets or sets the power boost level for unknown pilots.  
Public PropertyUserBoostLevelsGets or sets the array of power boost levels for each user ID in the resource map.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public Methodstatic (Shared in Visual Basic)CastToExtensionTypeThis method casts the supplied object to the MeasurementExtension type. Some tools are unable to use the generic methods provided on Agilent.SA.Vsa.Measurement class, so this is provided as an alternative.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public Methodstatic (Shared in Visual Basic)ExtensionTypeReturns the type for instances this measurement extension. Some tools are unable to use the generic methods provided on Agilent.SA.Vsa.Measurement class, so this is provided as an alternative.  
Public MethodForceRebuildKeyMapThis method is used to force a refresh of the key map. This is necessary in cases where the key mappings to the API objects change. This can happen when the index of an item within a collection is reflected in the key name, and an item is removed from the middle of a collection. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodGetActivePortsPerAllocationGets an array of active ports associated with each allocation ID, as listed in the resource map.  29.00
Public MethodGetCdmGroupSubcarrierCountPerFramePartGets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit, associated with each frame part ID, as listed in the per allocation frame part ID mappings.  29.00
Public MethodGetCdmGroupSubcarrierCountPerUserGets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  29.00
Public MethodGetCdmGroupSymbolCountPerFramePartGets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit, associated with each frame part ID, as listed in the per allocation frame part ID mappings.  29.00
Public MethodGetCdmGroupSymbolCountPerUserGets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  29.00
Public MethodGetCyclicSuffixPerSymbolGets the cyclic suffix guard interval of each OFDM symbol, as a fraction of the IFFT time length.  29.00
Public MethodGetFramePartIdPerAllocationGets an array of frame part IDs associated with each allocation ID, as listed in the resource map.  29.00
Public MethodGetGuardIntervalPerSymbolGets the cyclic prefix guard interval of each OFDM symbol, as a fraction of the IFFT time length.  29.00
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetModulationPerAllocationGets an array of modulation types associated with each allocation ID, as listed in the resource map.  29.00
Public MethodGetPilotValuesGets the array of reference pilot IQ values.  29.00
Public MethodGetPowerBoostLevelPerAllocationGets an array of power boost levels associated with each allocation ID, as listed in the resource map.  29.00
Public MethodGetPowerBoostLevelPerUserGets the array of power boost levels for each user ID in the resource map.  29.00
Public MethodGetPreambleValuesGets the array of reference preamble IQ values.  29.00
Public MethodGetQamIdentifierPowerBoostLevelsGets the array of power boost levels for each QAM Identifier.  29.00
Public MethodGetQamIdentifiersGets the array of QAM identifier values.  29.00
Public MethodGetQamLevelsGets the array of possible QAM constellation types.  29.00
Public MethodGetReferenceDataValuesGets an array of reference data (refData) in-phase/quadrature (IQ) values.  29.00
Public MethodGetResourceAllocationsGets an array specifying the allocation ID value mapped to each subcarrier and symbol OFDM Resource Unit (RU) in the signal. If N is the number of active TransmitterAntennas, the SetResourceAllocations array contains N sets of "per RU" (Resource Unit) associated values. Each set of "per RU" values is applied successively to each of the active TransmitterAntennas.  29.00
Public MethodGetResourceMapGets the array specifying the type of each subcarrier and symbol time resource within the signal.  29.00
Public MethodGetResourceModulationsGets an array specifying the modulation format of each subcarrier and symbol time in the signal.  29.00
Public MethodGetResourceTypePerAllocationGets an array of resource subcarrier types associated with each allocation ID, as listed in the resource map.  29.00
Public MethodGetSubcarrierCountPerChannelEstimationUnitPerUserGets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  27.40
Public MethodGetSymbolCountPerChannelEstimationUnitPerUserGets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  27.40
Public MethodGetTimeGapPerSymbolGets the time gap before each OFDM symbol, defined in samples at the OFDM system sample frequency.  29.00
Public MethodGetUserIdPerAllocationGets an array of user IDs associated with each allocation ID, as listed in the resource map.  29.00
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodPresetPreset the CustomOfdm measurement.  
Public MethodSetActivePortsPerAllocationSets an array of active ports associated with each allocation ID, as listed in the resource map.  29.00
Public MethodSetCdmGroupSubcarrierCountPerFramePartSets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit, associated with each frame part ID, as listed in the per allocation frame part ID mappings.  29.00
Public MethodSetCdmGroupSubcarrierCountPerUserSets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  29.00
Public MethodSetCdmGroupSymbolCountPerFramePartSets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit, associated with each frame part ID, as listed in the per allocation frame part ID mappings.  29.00
Public MethodSetCdmGroupSymbolCountPerUserSets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  29.00
Public MethodSetCyclicSuffixPerSymbolSets the cyclic suffix guard interval of each OFDM symbol, as a fraction of the IFFT time length.  29.00
Public MethodSetFramePartIdPerAllocationSets an array of frame part IDs associated with each allocation ID, as listed in the resource map.  29.00
Public MethodSetGuardIntervalPerSymbolSets the cyclic prefix guard interval of each OFDM symbol, as a fraction of the IFFT time length.  29.00
Public MethodSetModulationPerAllocationSets an array of modulation types associated with each allocation ID, as listed in the resource map.  29.00
Public MethodSetPilotValuesSets the array of reference pilot IQ values.  29.00
Public MethodSetPowerBoostLevelPerAllocationSets an array of power boost levels associated with each allocation ID, as listed in the resource map.  29.00
Public MethodSetPowerBoostLevelPerUserSets the array of power boost levels for each user ID in the resource map.  29.00
Public MethodSetPreambleValuesSets the array of reference preamble IQ values.  29.00
Public MethodSetQamIdentifierPowerBoostLevelsSets the array of power boost levels for each QAM Identifier.  29.00
Public MethodSetQamIdentifiersSets the array of QAM identifier values.  29.00
Public MethodSetQamLevelsSets the array of possible QAM constellation types.  29.00
Public MethodSetReferenceDataValuesSets or sets an array of reference data (refData) in-phase/quadrature (IQ) values.  29.00
Public MethodSetResourceAllocationsSets an array specifying the allocation ID value mapped to each subcarrier and symbol OFDM Resource Unit (RU) in the signal. If N is the number of active TransmitterAntennas, the SetResourceAllocations array contains N sets of "per RU" (Resource Unit) associated values. Each set of "per RU" values is applied successively to each of the active TransmitterAntennas.  29.00
Public MethodSetResourceMapSets the array specifying the type of each subcarrier and symbol time resource within the signal.  29.00
Public MethodSetResourceModulationsSets an array specifying the modulation format of each subcarrier and symbol time in the signal.  29.00
Public MethodSetResourceTypePerAllocationSets an array of resource subcarrier types associated with each allocation ID, as listed in the resource map.  29.00
Public MethodSetSubcarrierCountPerChannelEstimationUnitPerUserSets an array of subcarrier count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  27.40
Public MethodSetSymbolCountPerChannelEstimationUnitPerUserSets an array of symbol count per channel estimation CDM (Code Domain Multiplex) grouping unit for each user ID in the resource map.  27.40
Public MethodSetTimeGapPerSymbolSets the time gap before each OFDM symbol, defined in samples at the OFDM system sample frequency.  29.00
Public MethodSetUserIdPerAllocationSets an array of user IDs associated with each allocation ID, as listed in the resource map.  29.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Events

 NameDescriptionMinimum SW Version
Public EventPropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventPropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)14.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

See Also