All Classes Namespaces Files Functions Pages
Rx.OutOfSequence.Basic.ResultSnapshot Class Reference

Refreshable object containing the out-of-sequence results. More...

Methods

 ByteCount.Get
 Gets the current received bytes counter. More...
 
 Description.Get
 Returns a textual description of the object.
 
 Framesize.Max.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Maximum.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Min.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 Framesize.Minimum.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 Interval.Duration.Get
 Gets the configured duration of this results snapshot [NS]. More...
 
 PacketCount.Get
 Gets the received packet count. More...
 
 PacketCount.Invalid.Get
 Gets the received packet count for the invalid/corrupted packets. More...
 
 PacketCount.OutOfSequence.Get
 Gets the received packet count which were out of sequence. More...
 
 PacketCount.Valid.Get
 Gets the received packet count for packets which were not corrupted. More...
 
 Parent.Get
 Returns the parent object.
 
 Refresh.Timestamp.Get
 Returns the timestamp when the counters of this object where last refreshed. More...
 
 Refresh
 Refresh the results, get the new counters. More...
 
 Timestamp.First.Get
 Gets the timestamp [NS] of the first packet in this snapshot. More...
 
 Timestamp.Get
 Gets the snapshot timestamp [NS]. More...
 
 Timestamp.Last.Get
 Gets the current timestamp [NS] of the last packet in this snapshot. More...
 

Class overview

Refreshable object containing the out-of-sequence results.

Definition at line 20335 of file api.tcl.

Method documentation

Rx.OutOfSequence.Basic.ResultSnapshot::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

1 $outOfSequenceResult ByteCount.Get

Returns:

100 

Definition at line 20345 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Framesize.Max.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Deprecated:
since 2.6.4, please use Framesize.Maximum.Get instead
Example

This example gets the largest frame size received in this snapshot.

1 $outOfSequenceResult Framesize.Max.Get

Returns:

100 

Definition at line 20362 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Framesize.Maximum.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Since
2.6.4
Example

This example gets the largest frame size received in this snapshot.

1 $outOfSequenceResult Framesize.Maximum.Get

Returns:

100 

Definition at line 20374 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Framesize.Min.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Deprecated:
since 2.6.4, please use Framesize.Minimum.Get instead
Example

This example gets the smallest frame size received in this snapshot.

1 $outOfSequenceResult Framesize.Min.Get

Returns:

100 

Definition at line 20386 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Framesize.Minimum.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Since
2.6.4
Example

This example gets the smallest frame size received in this snapshot.

1 $outOfSequenceResult Framesize.Minimum.Get

Returns:

100 

Definition at line 20398 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Interval.Duration.Get

Gets the configured duration of this results snapshot [NS].

Since
2.3.0
Example

This example gets interval duration of this result snapshot [NS]

1 $outOfSequenceResult Interval.Duration.Get

Returns:

1000000000 

Definition at line 20410 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

1 $outOfSequenceResult PacketCount.Get

Returns:

100 

Definition at line 20420 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Invalid.Get

Gets the received packet count for the invalid/corrupted packets.

Example

This example gets the received invalid packet counter

1 $outOfSequenceResult PacketCount.Invalid.Get

Returns:

10 

Definition at line 20430 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.OutOfSequence.Get

Gets the received packet count which were out of sequence.

Example

This example gets the received out of sequence packet counter

1 $outOfSequenceResult PacketCount.OutOfSequence.Get

Returns:

10 

Definition at line 20440 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Valid.Get

Gets the received packet count for packets which were not corrupted.

Example

This example gets the valid packet counter

1 $outOfSequenceResult PacketCount.Valid.Get

Returns:

10 

Definition at line 20450 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Refresh

Refresh the results, get the new counters.

Example
1 $outOfSequenceResult Refresh

Definition at line 20477 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Refresh.Timestamp.Get

Returns the timestamp when the counters of this object where last refreshed.

Note
This is not the same as Timestamp.Get
Example
1 $outOfSequenceResult Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 20467 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Timestamp.First.Get

Gets the timestamp [NS] of the first packet in this snapshot.

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Example

This example gets the timestamp [NS] of the first received packet in this snapshot

1 $outOfSequenceResult Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 20489 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $outOfSequenceResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 20499 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Timestamp.Last.Get

Gets the current timestamp [NS] of the last packet in this snapshot.

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Example

This example gets the timestamp [NS] of the last received packet in this snapshot

1 $outOfSequenceResult Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 20511 of file api.tcl.