Keysight Pathwave 89600 VSA .NET API
SummaryNames Property
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > MeasurementData Class : SummaryNames Property


Glossary Item Box

Gets an array of all available key names (result names) if this MeasurementData contains a Summary Table.

Syntax

Visual Basic (Declaration) 
Public MustOverride ReadOnly Property SummaryNames As String()
C# 
public abstract string[] SummaryNames {get;}
C++/CLI 
public:
abstract property array<String^>^ SummaryNames {
   array<String^>^ get();
}

Remarks

The SummaryNames, Summary(integer), and SummaryUnit(integer) properties are used to programmatically query Summary Table results. Each property is required to return a complete data result value. In some cases, the data result is a vector (array).

Their specific function is described below:

  1. SummaryNames returns an array containing a list of all available data result names for the Summary Table.
  2. Summary(Int32) gets the value of a data result at the specified key index in the Summary Table.
  3. Summary(String) gets the value of a data result for the specified key name in the Summary Table.
  4. SummaryUnit(Int32) gets the measurement units (secs, dbm, etc.) of a data result at the specified key index in the Summary Table.
  5. SummaryUnit(String) gets the measurement units (secs, dbm, etc.) of a data result for the specified key name in the Summary Table.

The SummaryNames property returns an array containing a list of the available Summary Table key names (data result names) for the Summary Table. This list is used to assign unique keys for each data result in the Summary Table. The keys are used in the Summary(Int32) and SummaryUnit(Int32) methods to query a corresponding data result value and unit. Alternately, you can use the key names with Summary(String) and SummaryUnit(String) methods to query a corresponding data result value and unit.

If the data result returned from Summary(Int32) or Summary(String) is an array (in other words, vector data) then the Summary(Int32,Int32) or Summary(String,Int32) methods may be used to return a single element of the vector.

Not all modulation formats can be used with these properties. Also, each modulation format has a unique set of Summary Table Traces and data results. The "Available Summary Table Results" topic provides all the specific information needed to use these properties including; the supported modulation formats, available Summary Tables traces and list of data results with corresponding key index values.

To learn how to use these properties to programmatically query Summary Table results. see "How to Query Summary Table Data Results".

Requirements

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

See Also