QueryResultCommand Object


Description:

Provides access to the results databases produced by Spirent TestCenter. Specifically, you can access the views of the database that are used by the Spirent TestCenter Results Reporter application.

Important: Node names (a node is one of the named units in the Results Reporter tree, such as Traffic") and column names are case-sensitive, and cannot contain spaces when used with this command. If you use the names that are displayed in the Results Reporter, you must remove any spaces. For example, Basic Traffic Counters in Results Reporter becomes BasicTrafficCounters for use with this command. See the examples in the attributes below. Spaces in names that are returned are stripped out.

Can be used with Command Sequencer: No

Parents: Sequencer

QueryResultCommand Writable Attributes

Attribute Description
AttributeList

Specifies which attributes (columns) to return. The default (no argument) returns all columns. Use a space-separated list of column names. If there are spaces in the column name, remove the spaces in the corresponding argument.

Example: -attributeList "PortName TotalTxFrameCount TotalRxFrameCount"

Type: string

Default: "" (empty string)

Count

Number of rows to return. By default this count starts from the first row, but you can use the Offset attribute to start from a different row.

Type: u32

Default: 0xffffffff

DatabaseConnectionString

Name of the results database (summary database or iteration file) to open and query.

Type: inputFilePath

Default: result.db

Filter

Filters the rows that are returned. The default returns all rows. You can use the following comparison operators:

== (equals)

!= (does not equal)

> (greater than)

>= (greater than or equal to)

< (less than)

<= (less than or equal to)

Example: -filter "TotalTxFrameCount > 50"

This example will return rows that have TotalTxFrameCount values of 75 or 300, but not will not return rows with TotalTxFrameCount values of 48 or 50.

Type: string

Default: "" (empty string)

Offset

Used with the Count attribute to retrieve a subset of rows. The value of Offset is the first row number of Count number of rows to retrieve.

Type: u32

Default: 0

ResultPath

Complete path to the Results Reporter tree view node. Use forward slashes / to separate nodes. The default returns the entire tree.

Example: -resultPath "SavedResultTraffic/BasicTrafficCounters/BasicCounters"

Type: string

Default: "" (empty string)

ResultType

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Use the ResultPath attribute instead.

Type: string

Default: "" (empty string)

QueryResultCommand Read-Only Attributes

Read-Only Attribute Description
Columns

Name of each column returned in the Output attribute.

Example: -Columns {PortName TotalTxFrameCount TotalRxFrameCount}

Type: string

Default: "" (empty string)

Output

A Tcl list of lists containing each row of the output. The names of the columns of this output are returned by the Columns attribute.

Example: -Output {{{Port //7/3} 100 0} {{Port //7/4} 0 100}}

This example shows two rows. The column names for this example are given in the example for the Columns attribute.

Type: string

Default: "" (empty string)