Keysight 89600 VSA .NET API
Allocation Class Members
See Also  Properties  Methods  Events
Keysight.SA.Vsa.FlexFrame.Interfaces Assembly > Keysight.SA.Vsa.FlexFrame Namespace : Allocation Class

Glossary Item Box

The following tables list the members exposed by Allocation.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyAllocationTypeGets or sets the type of the allocation: preamble, data, pilot, or idle.  
Public PropertyBitSequenceLocationAutoDetectedGets or sets a value indicating whether to detect the position within the reference bit sequence (PN sequence or CustomSequenceStyle.BitSequence) or to assume that the bit sequence starts at the StartSymbolIndex.  26.00
Public PropertyCustomModulationNameGets or sets the name of the CustomModulation to use for this allocation.  27.40
Public PropertyCustomSequenceStyleGets or sets the type of sequence when PayloadType = PayloadType.Custom.  
Public PropertyDvbModulationCodingGets or sets the DVB-S2/S2X modulation/coding, which defines the constellation and bit mapping.  26.00
Public PropertyEnabledGets or sets a value indicating whether this allocation is enabled or not.  26.20
Public PropertyEndsAtEndOfFrameGets or sets a value indicating whether this allocation ends at the end of the frame.  
Public PropertyEndSymbolIndexGets or sets the end symbol index for this allocation. Alternative to setting Length.  
Public PropertyEstimationEnabledGets or sets a value indicating whether Allocation is used for channel estimation.  
Public PropertyFramePartGets or sets the FramePart associated with this allocation.  
Public PropertyFramePartIndexGets or sets the index of the FramePart that this allocation belongs to.  
Public PropertyIncludedInBitErrorRateCalculationGets or sets a value indicating whether to include this allocation in Bit Error Rate (BER) calculations.  26.00
Public PropertyIncludedInEvmGets or sets a value indicating whether the frame segment is included in overall EVM calculation.  
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 PropertyLengthGets or sets the total length of this allocation in number of symbols. Alternative to setting EndSymbolIndex.  
Public PropertyModulationGets or sets the ModulationFormat for this Allocation.  
Public PropertyNameGets or sets the name of this Allocation.  
Public PropertyPatternRepeatEnabledGets or sets a value indicating whether to use a custom repeating pattern to indicate the symbols that belong to this allocation.  
Public PropertyPayloadTypeGets or sets the PayloadType contained in the Allocation.  
Public PropertyPowerBoostLevelGets or sets a value indicating the relative power boosting (dB) of this Allocation relative to the other Allocations.  
Public PropertyRepetitionIntervalGets or sets the repetition interval of the active symbols.  
Public PropertyScramblerIdGets or sets the Scrambler.Id of the Scrambler to apply to this Allocation.  26.00
Public PropertyScramblingEnabledGets or sets a value indicating whether to apply the Scrambler indicated by ScramblerId.  26.00
Public PropertyStartSymbolIndexGets or sets the beginning of this allocation as an offset from the first symbol in the frame.  
Public PropertySynchronizationEnabledGets or sets a value indicating whether Allocation is used for synchronization.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
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 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 MethodGetActiveIndexesGets the active symbol indexes for this allocation when PatternRepeatEnabled = true.  
Public MethodGetBitSequenceGets the bit sequence used when CustomSequenceStyle = CustomSequenceStyle.BitSequence and PayloadType = PayloadType.Custom.  
Public MethodGetIQSymbolSequenceGets the custom I/Q sequence used when CustomSequenceStyle = CustomSequenceStyle.IQSequence and PayloadType = PayloadType.Custom.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodSetActiveIndexesSets the active symbol indexes for this allocation.  
Public MethodSetBitSequenceSets the bit sequence used when CustomSequenceStyle = CustomSequenceStyle.BitSequence and PayloadType = PayloadType.Custom.  
Public MethodSetIQSymbolSequenceSets the custom I/Q sequence used when CustomSequenceStyle = CustomSequenceStyle.IQSequence and PayloadType = PayloadType.Custom.  
‡ 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