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

Glossary Item Box

The following tables list the members exposed by Measurement.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyAnalysisGets a handle to the measurement's Analysis object.  25.40
Public PropertyAverageGets a handle to the Average object for the measurement.  
Public PropertyCorrectionGets a handle to the measurement's correction object.  29.00
Public PropertyCorrectionsGets a collection of Correction objects (one per logical channel)  
Public PropertyCustomStepsGets the custom steps collection. Internal use only.  
Public PropertyErrorGets the current measurement error  
Public PropertyFrequencyGets a handle to the Frequency object for the measurement.  
Public PropertyInputGets a handle to the Input object for the measurement.  
Public PropertyInputCorrectionsGets a collection of InputCorrection objects (one per input channel)  
Public PropertyInputDomainGets a value indicating what kind of input data the analysis part of the measurement requires.  18.50
Public PropertyIsConcurrentGets a value indicating whether this measurement may be run concurrently with the selected measurement  15.00
Public PropertyIsContinuousGets or sets a value indicating whether the measurement is continuous.  
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 PropertyIsMeasurementDoneGets a value indicating whether the measurement is complete.  
Public PropertyIsRecordingGets a value indicating whether the measurement is currently making a recording.  
Public PropertyIsRunningGets a value indicating whether the measurement is currently running.  
Public PropertyIsShareEnabledGets or sets a value indicating whether the measurement can share hardware with another measurement.  15.00
Public PropertyIsSupportedBySelectedAnalyzerGets a value indicating whether the current measurement extension is supported by the currently selected analyzer hardware.  18.50
Public PropertyIsTestPassGets a value indicating whether the current measurement (limit) test passed  
Public PropertyMeasurementExtensionGets a handle to the current extension object. The caller must cast it to the appropriate type (indicated by the ExtensionType property) to access members of the object.  
Public PropertyMeasurementExtensionTypeGets the type of the current measurement. It returns the same type as MeasurementExtension().InterfaceType, but provides a more convenient way to bind to a PropertyChanged notification.  
Public PropertyMeasurementSyncGets or sets a value indicating whether the measurement can trigger sync with another measurement.  16.00
Public PropertyMessageGets the current measurement message  
Public PropertyNameGets or sets the measurement name.  
Public PropertyProcessingExtensionsGets the collection of processing extensions for the measurement.  16.00
Public PropertyRecordPercentDoneGets the progress of the current recording (0.0 to 100.0 percent).  
Public PropertySelectedAnalyzerGets or sets the hardware to use for this measurement.  
Public PropertySpectrumGets a handle to the measurement's Spectrum object.  18.50
Public PropertyStatusGets a handle to the Status object for the measurement.  
Public PropertyTimeGets a handle to the Time object for the measurement.  
Public PropertyUserCorrectionGets the UserCorrection object.  26.00
Public PropertyUserStatusGets a handle to a Status object for the measurement. UserStatus should only be used by code interacting with the UserInput API.  
‡ 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 MethodGetConcurrentMeasurementsGets the collection of measurements that may be run concurrently with this measurement.  15.00
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetMeasurementExtension<T>Returns the current measurement extension cast to the requested type.  
Public MethodGetRecordMeasurementsGets the collection of measurements that may be recorded concurrently with this measurement.  18.50
Public MethodGetSharedMeasurementsGets the collection of measurements that are shared with this measurement.  15.00
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodIsCalculateMeasurementDataOverloaded. Set whether the passed measurement data is calculated even if not displayed.  
Public MethodIsCalculateMeasurementDataClearClears all measurement data results so they are not calculated if not displayed.  
Public MethodIsEnabledMeasurementExtensionGets a value indicating whether the specified measurement type is enabled.  
Public MethodMeasurementDataReturns the measurement data for the passed data name.  
Public MethodNewChangeGroupTurns off the normal measurement updates that occur after property changes until the System.IDisposable.Dispose method is called on the returned IChangeGroup interface.  
Public MethodPauseCauses the measurement to transition to the Paused state.  
Public MethodPresetPresets the current measurement to its factory default setup state. This method does not change the current hardware configuration for the measurement.  
Public MethodPresetTracesPreset the trace results for this measurement.  
Public MethodRecallSignalSetupRecalls a VSA setup file at the specified path, replacing only the signal description parts of measurement setup.  21.20
Public MethodRecallSSFileRecall Signal Studio setup from the named file  
Public MethodRecordOverloaded. Pauses the current measurement and start recording the input data.  
Public MethodResetImmediately stops the measurement, clearing all measurement data.  
Public MethodRestartCauses the measurement to restart. The Average count is reset to 0 and the measurement transitions to the Running State.  
Public MethodResumeCauses the measurement to transition to the Running state.  
Public MethodSetMeasurementExtensionOverloaded. Changes the current measurement to the indicated type (if necessary) and returns an appropriately typed handle to the extension object.  
Public MethodWaitForMeasurementDoneOverloaded. Wait 10 seconds for the measurement to complete.  
Public MethodWaitForRecordingDoneOverloaded. Wait 10 seconds for the recording to complete.  
‡ 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