All Classes Namespaces Files Functions Pages
Tx.Frame.ResultSnapshot Class Reference

Methods

 ByteCount.Get
 Gets the current transmitted bytes. More...
 
 Description.Get
 Returns a textual description of the object.
 
 Framesize.Max.Get
 Gets the size (in bytes) of the largest frame transmitted in this snapshot. More...
 
 Framesize.Maximum.Get
 Gets the size (in bytes) of the largest frame transmitted in this snapshot. More...
 
 Framesize.Min.Get
 Gets the size (in bytes) of the smallest frame transmitted in this snapshot. More...
 
 Framesize.Minimum.Get
 Gets the size (in bytes) of the smallest frame transmitted in this snapshot. More...
 
 Interval.Duration.Get
 Gets the configured duration of this results snapshot [NS]. More...
 
 PacketCount.Get
 Gets the transmitted packets. 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

Definition at line 22733 of file api.tcl.

Method documentation

Tx.Frame.ResultSnapshot::ByteCount.Get

Gets the current transmitted bytes.

Example

This example gets the transmitted bytes

1 $frameResultData ByteCount.Get

Returns:

100 

Definition at line 22743 of file api.tcl.

Tx.Frame.ResultSnapshot::Framesize.Max.Get

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

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Deprecated:
since 2.5.0, please use Framesize.Maximum.Get instead
Example

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

1 $frameResultData Framesize.Max.Get

Returns:

100 

Definition at line 22762 of file api.tcl.

Tx.Frame.ResultSnapshot::Framesize.Maximum.Get

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

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

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

1 $frameResultData Framesize.Maximum.Get

Returns:

100 

Definition at line 22776 of file api.tcl.

Tx.Frame.ResultSnapshot::Framesize.Min.Get

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

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Deprecated:
since 2.5.0, please use Framesize.Minimum.Get instead
Example

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

1 $frameResultData Framesize.Min.Get

Returns:

100 

Definition at line 22790 of file api.tcl.

Tx.Frame.ResultSnapshot::Framesize.Minimum.Get

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

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

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

1 $frameResultData Framesize.Minimum.Get

Returns:

100 

Definition at line 22804 of file api.tcl.

Tx.Frame.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 $frameResultData Interval.Duration.Get

Returns:

1000000000 

Definition at line 22816 of file api.tcl.

Tx.Frame.ResultSnapshot::PacketCount.Get

Gets the transmitted packets.

Example

This example gets the transmitted packets

1 $frameResultData PacketCount.Get

Returns:

100 

Definition at line 22826 of file api.tcl.

Tx.Frame.ResultSnapshot::Refresh

Refresh the results, get the new counters.

Example
1 $frameResultData Refresh

Definition at line 22853 of file api.tcl.

Tx.Frame.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 $frameResultData Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 22843 of file api.tcl.

Tx.Frame.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 transmitted packet in this snapshot

1 $frameResultData Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 22865 of file api.tcl.

Tx.Frame.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $frameResultData Timestamp.Get

Returns:

1413475070000000000 

Definition at line 22875 of file api.tcl.

Tx.Frame.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 transmitted packet in this snapshot

1 $frameResultData Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 22887 of file api.tcl.