Keysight Pathwave 89600 VSA .NET API
Allocation Class Members
See Also  Properties  Methods  Events
Agilent.SA.Vsa.CustomOfdm.Interfaces Assembly > Agilent.SA.Vsa.CustomOfdm 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 PropertyCustomSequenceStyleGets or sets the type of sequence when PayloadType = PayloadType.Custom.  
Public PropertyEnabledGets or sets a value indicating whether this allocation is enabled or not.  26.20
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 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 PropertyModulationGets or sets the ModulationFormat for this Allocation.  
Public PropertyNameGets or sets the Name of 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 PropertyUserNameGets or sets the associated UserName assigned to this Allocation for the purpose of results reporting within the OFDM Data Burst Info results trace.  29.00
Public PropertyUserNameAutoGets or sets a value indicating whether this allocation's associated UserName is automatically set equal to the allocation Name, or instead is manually set.  29.00
‡ 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 MethodGetActivePortIndexesGets the active antenna port indexes for this allocation.  29.00
Public MethodGetActiveSubcarrierIndexesGets the active subcarrier indexes for this allocation.  
Public MethodGetActiveSymbolIndexesGets the active symbol indexes for this allocation.  
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 MethodSetActivePortIndexesSets the active antenna port indexes for this allocation.  29.00
Public MethodSetActiveSubcarrierIndexesSets the active subcarrier indexes for this allocation.  
Public MethodSetActiveSymbolIndexesSets 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