ResultOptions Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Configure result options.

Automatically created from: Project

ResultOptions Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
CollectStrayFrame

Whether to collect stray frames on the port when RxStreamSummaryResults is subscribed.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Collect stray frames.
FALSE

Do not collect stray frames.
DeleteAllAnalyzerStreams

Whether to delete all streams from analyzer when clearing results with ResultsClearAllCommand.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Delete all analyzer streams.

FALSE

Do not delete all analyzer streams.

JitterMode

Choose which method to use for calculation of jitter values.

Type: enum

Default: RFC3393ABSOLUTEVALUE

Possible Values:

Value Description
RFC3393ABSOLUTEVALUE

Use specification from RFC3393 to calculate jitter values.

RFC4689ABSOLUTEVALUE

Use specification from RFC4689 to calculate jitter values.

PreambleByteLength

Ethernet preamble byte length used for layer1 counter calculation.

Type: u8

Default: 8

Range: 4 - 32
ResultViewMode

Choose which counters will be included in the results view. This applies only to stream-related views.

Choose a result view mode prior to running any test. Changing this mode while a test is running will invalidate the current counter results.

The following counters are available in all modes: Comp16_1, Comp16_2, Comp16_3, Comp16_4, Comp32, FrameCount, and StreamIndex.

Type: enum

Default: BASIC

Possible Values:

Value Description
BASIC

Provides the basic traffic counters. The following additional counters are available in this mode:

AvgLatency, BitRate, DroppedFrameCount, DroppedFrameRate, DuplicateFrameCount, DuplicateFrameRate, ExpectedSeqNum, FcsErrorFrameCount, FcsErrorFrameRate, FrameRate, InOrderFrameCount, InOrderFrameRate, Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LateFrameCount, LateFrameRate, MaxFrameLength, MaxLatency, MinFrameLength, MinLatency, OctetCount, OctetRate, PrbsBitErrorCount, PrbsBitErrorRate, PrbsFillOctetCount, PrbsFillOctetRate, ReorderedFrameCount, ReorderedFrameRate, SeqRunLength, SigFrameCount, SigFrameRate, TcpUdpChecksumErrorCount, TcpUdpChecksumErrorRate.
HISTOGRAM

Provides the histogram counters for the following histograms: frame length, latency, sequence diffcheck, and sequence run length. The following additional counters are available in this mode:

AvgLatency, BitRate, FcsErrorFrameCount, FcsErrorFrameRate, FrameRate, HistBin1Count to HistBin16Count, HistBin1Rate to HistBin16Rate, InSeqFrameCount, InSeqFrameRate, Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LastSeqNum, MaxFrameLength, MaxLatency, MinFrameLength, MinLatency, OctetCount, OctetRate, OutSeqFrameCount, OutSeqFrameRate, PrbsBitErrorCount, PrbsBitErrorRate, PrbsFillOctetCount, PrbsFillOctetRate, SeqRunLength, SigFrameCount, SigFrameRate, TcpUdpChecksumErrorCount, TcpUdpChecksumErrorRate.
JITTER

Provides the histogram and minimum, maximum, and average jitter counters. The following additional counters are available in this mode:

AvgJitter, FirstArrivalTime, HistBin1Count to HistBin16Count, HistBin1Rate to HistBin16Rate, InSeqFrameCount, LastArrivalTime, LastSeqNum, MaxJitter, MaxLatency, MinJitter, MinLatency, OutSeqFrameCount, SeqRunLength, TotalJitter, TotalJitterRate.
INTERARRIVALTIME

Provides the inter-arrival histogram and minimum, maximum, and average counter values. The following additional counters are available in this mode:

AvgInterarrivalTime, FirstArrivalTime, FrameRate, HistBin1Count to HistBin16Count, HistBin1Rate to HistBin16Rate, InSeqFrameCount, InSeqFrameRate, Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LastArrivalTime, LastSeqNum, MaxInterarrivalTime, MaxLatency, MinInterarrivalTime, MinLatency, OutSeqFrameCount, OutSeqFrameRate, SeqRunLength, TotalInterarrivalTime.
FORWARDING

Provides the advanced sequencing counters and minimum, maximum, and average inter-arrival counters. The following additional counters are available in this mode:

AvgInterarrivalTime, BitRate, DroppedFrameCount, DroppedFrameRate, DuplicateFrameCount, DuplicateFrameRate, ExpectedSeqNum, FirstArrivalTime, FrameRate, InOrderFrameCount, InOrderFrameRate, Ipv4ChecksumErrorCount, Ipv4ChecksumErrorRate, LastArrivalTime, LateFrameCount, LateFrameRate, MaxFrameLength, MaxInterarrivalTime, MinFrameLength, MinInterarrivalTime, OctetCount, OctetRate, PrbsBitErrorCount, PrbsBitErrorRate, PrbsFillOctetCount, PrbsFillOctetRate, ReorderedFrameCount, ReorderedFrameRate, SeqRunLength, TotalInterarrivalTime.
LATENCY_JITTER

Provides the minimum, maximum and average latency and jitter counters. The following additional counters are available in this mode:

SeqRunLength, ExpectedSeqNum, DroppedFrameCount, DroppedFrameRate, InOrderFrameCount, InOrderFrameRate, ReorderedFrameCount, ReorderedFrameRate, DuplicateFrameCount, DuplicateFrameRate, LateFrameCount, LateFrameRate, FirstArrivalTime, LastArrivalTime.
LATENCY_JITTER_RFC5481

Provides the minimum, maximum and average latency and jitter counters. The following additional counters are available in this mode:

SeqRunLength, ExpectedSeqNum, DroppedFrameCount, DroppedFrameRate, InOrderFrameCount, InOrderFrameRate, ReorderedFrameCount, ReorderedFrameRate, DuplicateFrameCount, DuplicateFrameRate, LateFrameCount, LateFrameRate, FirstArrivalTime, LastArrivalTime.
TSN_REDUNDANCY_BASIC

TSN_REDUNDANCY_ADVANCED

ADV_FLOW_TRACKING

Advanced flow tracking mode.
SaveAtEotProperties

Configuration properties to be saved at the end of test.

Type: string

Default: "" (empty string)

SaveOnlyCountersFromResultViewMode

Save end of test counters according to result view mode.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Save end of test counters according to result view mode.
FALSE

Disable Save end of test counters according to result view mode.
StopAnalyzerBeforeClearingResults

Whether to stop analyzers before clearing results with ResultsClearAllCommand. You must set this before invoking ResultsClearAllCommand.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Stop all analyzers, clear results for all views, and then start the analyzers again.
FALSE

Clear results for all views without stopping analyzers.
StopTrafficBeforeClearingResults

Whether to stop traffic generators before clearing results with ResultsClearAllCommand. You must set this before invoking ResultsClearAllCommand.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Stop all generators, clear results for all views, and then start the generators again.
FALSE

Clear results for all views without stopping generators.
SyncClearResults

NOTE: This attribute is not available if StopTrafficBeforeClearingResults or StopAnalyzerBeforeClearingResults is TRUE.

Whether to synchronize clearing across all ports when you invoke ResultsClearAllCommand. Generators and analyzers will not be stopped.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Synchronize clearing across all ports.
FALSE

Do not synchronize clearing across all ports.
TimedRefreshInterval

Define the refresh interval in seconds when PERIODIC mode is selected as TimedRefreshResultViewMode.

Type: u16

Default: 10

Range: 1 - 65535
TimedRefreshResultViewMode

Auto refresh for result views which does not update results in real time.

Type: enum

Default: MANUAL

Possible Values:

Value Description
MANUAL

Result view does not get refreshed automatically.
CONTINUOUS

Result view get refreshed continuously.
PERIODIC

Result view get refreshed as per interval defined in TimedRefreshInterval.
TxPortExpectMCastTrafficSentFromSelf

Whether the Tx port will expect to receive traffic from itself.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Tx port will expect to receive traffic from itself.
FALSE

Tx port will not expect to receive traffic from itself.

ResultOptions Read-Only Attributes

There are no read-only attributes.