Keysight Pathwave 89600 VSA .NET API
Summary(Int32) Method
See Also  Example
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > MeasurementData Class > Summary Method : Summary(Int32) Method


keyIndex
The key index specifies a particular Summary Table data result. This is the index of the keys array returned by SummaryNames.

Glossary Item Box

Gets the value of a data result for the Summary Table using a key index.

Syntax

Visual Basic (Declaration) 
Public Overloads MustOverride Function Summary( _
   ByVal keyIndex As Integer _
) As Object
C# 
public abstract object Summary( 
   int keyIndex
)
C++/CLI 
public:
abstract Object^ Summary( 
   int keyIndex
)

Parameters

keyIndex
The key index specifies a particular Summary Table data result. This is the index of the keys array returned by SummaryNames.

Return Value

The Summary value or null if the key index is not in the table.

Remarks

See SummaryNames for a description of how to read the Summary Table data results. When calling this function, the array returned must be converted safely to a float[] or double[] type. The example for this function demonstrates how to safely do this.

Example

C#Copy Code
Array result = (Array)Summary([index input]);
double[] dblResults = new double[result.Length];
int idx = 0;
foreach(var element in result)
{
    dblResults[idx] = Convert.ToDouble(element);
    ++idx;
}

Requirements

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

See Also