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 23413 of file api.tcl.

Method documentation

Tx.Frame.ResultSnapshot::ByteCount.Get

Gets the current transmitted bytes.

Example

This example gets the transmitted bytes

$frameResultData ByteCount.Get

Returns:

100 

Definition at line 23423 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When 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.

$frameResultData Framesize.Max.Get

Returns:

100 

Definition at line 23442 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.5.0

Example

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

$frameResultData Framesize.Maximum.Get

Returns:

100 

Definition at line 23456 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When 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.

$frameResultData Framesize.Min.Get

Returns:

100 

Definition at line 23470 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Since

2.5.0

Example

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

$frameResultData Framesize.Minimum.Get

Returns:

100 

Definition at line 23484 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]

$frameResultData Interval.Duration.Get

Returns:

1000000000 

Definition at line 23496 of file api.tcl.

Tx.Frame.ResultSnapshot::PacketCount.Get

Gets the transmitted packets.

Example

This example gets the transmitted packets

$frameResultData PacketCount.Get

Returns:

100 

Definition at line 23506 of file api.tcl.

Tx.Frame.ResultSnapshot::Refresh

Refresh the results, get the new counters.

Example

$frameResultData Refresh

Definition at line 23533 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

$frameResultData Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 23523 of file api.tcl.

Tx.Frame.ResultSnapshot::Timestamp.First.Get

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

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

$frameResultData Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 23545 of file api.tcl.

Tx.Frame.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$frameResultData Timestamp.Get

Returns:

1413475070000000000 

Definition at line 23555 of file api.tcl.

Tx.Frame.ResultSnapshot::Timestamp.Last.Get

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

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

$frameResultData Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 23567 of file api.tcl.