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

Glossary Item Box

The following tables list the members exposed by MarkerCollection.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyAcpAdjacentChannelsGets the collection of ACP adjacent channels.  
Public PropertyAcpReferenceAlphaGets or sets the RRC alpha value for the reference.  
Public PropertyAcpReferenceBWGets or sets the bandwidth of the carrier channel in Hz.  
Public PropertyAcpReferenceOffsetFreqGets or sets the offset between the measurement center frequency and the reference carrier frequency.  
Public PropertyCarrierResultGets the result of the carrier marker.  
Public PropertyCountGets the number of items in the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)
Public PropertyIsAcpRrcShapeGets or sets a value indicating whether the ACP filter for the reference channel has an RRC shape (true) or a rectangular shape (false).  
Public PropertyIsAcpVisibleGets or sets a value indicating whether ACP markers are visible or not.  
Public PropertyIsCarrierGets or sets a value indicating whether the carrier marker is visible.  
Public PropertyIsConsolidateGets or sets a value indicating whether the code domain Y marker values are consolidated.  
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 PropertyIsLimitVisibleGets or sets a value indicating whether the limit test for this trace is enabled (visible).  
Public PropertyIsObwVisibleGets or sets a value indicating whether the OBW marker is visible.  
Public PropertyIsPeakExcursionGets or sets a value indicating whether PeakExcursion is used to find a peak.  18.50
Public PropertyIsPeakThresholdGets or sets a value indicating whether PeakThreshold is used to find a peak.  18.50
Public PropertyItemGet the item at a specified index. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)
Public PropertyLimitNameGets or sets the name of the limit test to apply to this trace.  
Public PropertyLimitResultCountGets the number of limit line test results available.  
Public PropertyObwCentroidGets the frequency, in Hz, of the calculated centroid of the occupied band.  
Public PropertyObwPowerGets or sets the fraction of the total power in the signal that is considered "in band".  
Public PropertyPeakExcursionGets or sets a value which is the minimum amplitude (dB) excursion to indicate a peak.  18.50
Public PropertyPeakThresholdGets or sets a value which is the minimum amplitude (dBm) threshold to indicate a peak.  18.50
Public PropertyPolarFormatGets or sets if x-vs-y trace formats show markers as real/imaginary or magnitude/phase.  
Public PropertySelectedIndexGets or sets the 0-based index of the selected Marker.  
Public PropertySelectedItemGets or sets the selected Marker.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodClearTurn off all markers (Marker.IsVisible set to False) for this trace.  
Public MethodCloseToOverloaded. Return the closest visible marker to the passed pixel location.  
Public MethodCreateCreates a new marker.  
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 MethodGetEnumeratorGets an enumerator for the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIndexOfOverloaded. Gets the index location of the specified item within the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodLimitResultReturn the test result of the specified limit line.  
Public MethodRemoveRemove a marker from the collection.  
Public MethodRemoveAtRemove a marker from the collection.  
Public MethodRemoveLastRemove the last marker from the marker collection.  
Public MethodTopPeaksReturns a list (pairs of x- and y-values) of all the peaks.  18.50
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Events

 NameDescriptionMinimum SW Version
Public EventCollectionChangedOccurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)
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 EventRemoteCollectionChangedOccurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from Agilent.SA.Vsa.RemotableCollection<Marker>)14.00
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