Keysight Pathwave 89600 VSA .NET API
Value Property
See Also  Example
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > Status Class : Value Property


Glossary Item Box

Gets the current status events value.

Syntax

Visual Basic (Declaration) 
Public MustOverride ReadOnly Property Value As StatusBits
C# 
public abstract StatusBits Value {get;}
C++/CLI 
public:
abstract property StatusBits Value {
   StatusBits get();
}

Property Value

bitwise-OR of StatusBits

Remarks

Returns the current Value of all measurement status bits. Typically, you use the status Value to determine the following:

  • Measurement is in progress
  • Calibration is in progress
  • Recording is in progress

The measurement, calibration, and recording status bits are not as dynamic as other status bits and are easily monitored by looking at the status Value. Other status bits may transition several times during a measurement and should be checked using status masks and status events instead of the status Value.

Note:
There are internal, undocumented status bits that also affect the status Value. The internal status bits may be a one or zero. Therefore, make sure you mask the status Value to exclude all bits except those you are interested in (using boolean &) or use the Enum.HasFlag method.

Example

C#Copy Code
bool isRecording = app.Measurements.SelectedItem.Status.Value.HasFlag(StatusBits.Recording);

Requirements

Target Platforms: Windows 11 Professional or Enterprise; Windows 10 Professional, Enterprise, or Education (64-bit)

See Also