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

Glossary Item Box

The following tables list the members exposed by Macro.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyBuildStatusGets any errors or warnings from the previous Build operation.  14.00
Public PropertyCodePathGets the absolute path to the file containing the macro source code.  
Public PropertyIsBuildingGets a value indicating whether a build operation is currently in progress for the current macro.  
Public PropertyIsCurrentGets a value indicating whether a Build is required.  
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 PropertyIsRunnableGets a value indicating whether the macro is ready to run.  
Public PropertyIsRunningGets a value indicating whether the macro is currently running or not.  
Public PropertyLanguageGets the language in which the macro is implemented.  
Public PropertyNameGets or sets the name of the macro.  
Public PropertyTerminationStatusGets the termination status of the last completed Run operation.  14.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodBuildInitiates a build of the macro.  
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 MethodQuitRequest the macro to stop running.  
Public MethodRunStart the macro running.  
‡ 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