Frame.Mobile Class Reference

A Frame.Mobile is an object that configures the payload of a frame belonging to a Tx.Stream.Mobile object. More...

Methods
	Description.Get
	Returns a textual description of the object.
	FrameTag.Time.Get
	Returns the FrameTag.Tx object related to the timestamp injection for this frame. More...
	Parent.Get
	Returns the parent object.
	Payload.Get
	A method which returns the payload of a frame. More...
	Payload.Set bytes
	A method which sets the payload of a frame. More...
	Result.Clear
	Clears the transmit counters. More...
	Result.Get
	Returns the transmit counters. More...
	Result.History.Get
	Returns the current transmit history counters.

Class overview

A Frame.Mobile is an object that configures the payload of a frame belonging to a Tx.Stream.Mobile object.

A Frame.Mobile object is used for frame blasting. It is configured by a Tx.Stream.Mobile object and will be transmitted by the WirelessEndpoint.

Since

2.6.0

Example

This example will show how to add a frame to a stream and configure the payload.

set stream [ $device Tx.Stream.Add ] 
 set frame [ $stream Frame.Add ] 
 $frame Payload.Set "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"

Definition at line 3199 of file api.tcl.

Method documentation

Frame.Mobile::FrameTag.Time.Get

Returns the FrameTag.Tx object related to the timestamp injection for this frame.

Each frame can be enabled to have a timestamp inserted into the frame.

The FrameTag.Tx object which is returned by this method represents the current configuration of the TimeTag injection. This object can be used to configure the TimeTag injection.

For more detailed information about Frame tagging, you can also take a look at ByteBlower API Knowledgebase: Background: Adding FrameTags to your ByteBlower frame - structure and behaviour

Warning

this requires extra resources, so this option must be used with care.

Since

2.6.0

Returns

This method returns the FrameTag.Tx object for TimeTag injection of this frame.

Example

In this example, we will retrieve the FrameTag.Tx object for the TimeTag:

$frame FrameTag.Time.Get

Returns:

<FrameTag.Tx object> 

Definition at line 3226 of file api.tcl.

Frame.Mobile::Payload.Get

A method which returns the payload of a frame.

This method will return the UDP payload of the frame in a hexadecimal format.

Returns

This method returns the content in a hexadecimal string. All bytes are concatenated into one string.

Example

The current content of a frame can be requested like this:

$frame Payload.Get

Returns:

0001020304050607000102030405060700010203040506070001020304050607000102030405060700010203040506070001020304050607 

Definition at line 3245 of file api.tcl.

Frame.Mobile::Payload.Set			bytes

A method which sets the payload of a frame.

This method will change the payload of the frame. The value can be in different formats, e.g.

1. 0x01 0x02 0x03 0x04 0x05 ...
2. 0001020304050607
3. 00 01 02 03 04 05 ...

Parameters

bytes

Bytes can be of any of the following formats: 0x01 0x02 0x03 0x04 0x05 ... 0001020304050607 00 01 02 03 04 05 ...

Example

The content of a frame can be set like this:

$frame Payload.Set 0001020304050607000102030405060700010203040506070001020304050607000102030405060700010203040506070001020304050607

Definition at line 3259 of file api.tcl.

Frame.Mobile::Result.Clear

Clears the transmit counters.

This method will clear the transmit counters for this frame.

Example

$frame Result.Clear

Definition at line 3271 of file api.tcl.

Frame.Mobile::Result.Get

Returns the transmit counters.

Returns

Returns the transmit counters for this frame.

Example

$frame Result.Get

Returns:

<Tx.Frame.ResultSnapshot object> 

Definition at line 3283 of file api.tcl.