ResultDataSet Object


Description:

Used to request real-time results. After apply, the requested results are attached to this object using the ResultChild relation.

Spirent TestCenter creates this object automatically when you establish a subscription.

Parents: Project

Children: ChartAxis

Result children (automatically created): CounterResultFilterInfo, RealTimeResultColumnDefinition, RealTimeResultGroupDefinition, Result, ResultQuery, ResultViewData

Relations:

Side name
(Type)
Relative Description
ResultChild
(ResultChild)

Result, ResultViewData

Use this to connect a results object to an object.

ResultDataSet Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Description

Description of the results in this dataset.

Type: string

Default: "" (empty string)

DisablePaging

Disable paging.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

True.

FALSE

False.

Identifier

Do not modify. For internal GUI use. (Associates a ResultDataSet with a GUI presentation node or a table.)

Type: string

Default: "" (empty string)

InternalXmlFormatString

Do not modify. For internal GUI use.

Type: string

Default: "" (empty string)

NotifyInterval

How often updates should be sent. Currently only supported by certain types of l2l3 results.

Type: u16

Default: 1000

Range: 1000 - 60000

PageNumber

Used with the paged results mechanism. This attribute identifies the results page to retrieve. To retrieve all of the data produced by a subscription, set PageNumber to 1 and then increment its value until it reaches the TotalPageCount value.

Paged results mechanism is supported by the following result objects: AnalyzerPortResults, DiffServResults, FilteredStreamResults, GeneratorPortResults, PortAvgLatencyResults, RxCpuPortResults, RxPortPairResults, RxStreamBlockResults, RxStreamSummaryResults, RxTrafficGroupResults, TxCpuPortResults, TxPortPairResults, TxStreamBlockResults, TxStreamResults, TxTrafficGroupResults.

Type: u16

Default: 1

Path

Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node.)

Type: string

Default: "" (empty string)

PrimaryClass

Do not modify. For internal GUI use. (Associates a ResultDataSet with a presentation node.)

Type: string

Default: "" (empty string)

RecordsPerPage

Used with the paged results mechanism. Defines the amount of data in a results page. A record corresponds to the data associated with one results object.

See the PageNumber attribute for a list of the objects that support the paged results mechanism.

Type: u16

Default: 100

ResultViewOwner

Do not modify. For internal GUI use.

Type: enum

Default: SYSTEM

Possible Values:

Value Description
SYSTEM

Dataset was created by the system.

USER

Dataset was created by the user (in the GUI).

ResultDataSet Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ResultState
ResultHandleList

Contains the handles of results objects attached to this ResultDataSet.

Type: handle

Default: 0

TotalPageCount

Used with the paged results mechanism. Gives the total number of results pages. This number depends on the setting of the ResultsPerPage attribute.

See the PageNumber attribute for a list of the objects that support the paged results mechanism.

Type: u16

Default: 1