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

Glossary Item Box

The following tables list the members exposed by LimitLine.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyConnectPointsGets or sets an array containing the Connect values for all points in the limit line.  
Public PropertyCountGets the number of points in the limit line.  
Public PropertyDisplayGets or sets how limit and/or margin lines are drawn.  
Public PropertyEnabledGets or sets a value indicating whether this limit line is to be tested (enabled).  15.00
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 PropertyLineDrawGets or sets whether a single line or just the connect points are drawn for the limit/margin lines.  
Public PropertyNameGets or sets the name of the limit line. The name does not have to be unique.  
Public PropertyTraceFailGets or sets how a limit/margin failure is drawn on the trace.  
Public PropertyXDomainGets or sets whether the points are in the time or frequency domain.  
Public PropertyXPointsGets or sets an array containing the X values for all points in the limit line.  
Public PropertyXReferenceGets or sets whether the X points in the limit line are absolute or relative.  
Public PropertyXUnitNameGets the unit name of the X points.  
Public PropertyYFormatGets or sets whether the Y units are log (e.g. dB) or linear. Get/set whether the Y units are log (e.g. dB) or linear.  
Public PropertyYMarginGets or sets the Y offset between the limit line and the margin line.  
Public PropertyYMarginUnitNameGets the unit name of the Y margin.  
Public PropertyYPointsGets or sets an array containing the Y values for all points in the limit line.  
Public PropertyYReferenceGets or sets whether the Y points in the limit line are absolute or relative.  
Public PropertyYReferenceTraceGets or sets the name of the data header variable that contains the measurement-generated Y reference.  
Public PropertyYReferenceUserGets or sets the User-specified Y reference.  
Public PropertyYSideGets or sets whether the limit line is on the upper or lower side of the trace.  
Public PropertyYUnitGets or sets the Y unit type (Power, Peak, RMS).  
Public PropertyYUnitNameGets the unit name of the Y points.  
Public PropertyYUnitNameAbsoluteGets the unit name of the user Y reference.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodAddPointAdd a single point (X, Y, and Connect) to the limit line.  
Public MethodAddPointsAdd multiple points (X, Y, and Connect arrays) to the limit line.  
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 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 MethodRecallFileLoad the limit line with values from the saved limit line file.  
Public MethodRemoveAllPointsRemove all points in the limit line.  
Public MethodRemovePointRemove the passed point from the limit line.  
Public MethodSaveFileSave the limit line to a file.  
Public MethodSetPointSet a single new point (X, Y, and Connect) for the limit line and does not affect any other points.  
Public MethodSetPointsSet multiple points (X, Y, and Connect arrays) for the limit line (removing all previous points).  
‡ 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