byteblowerll.byteblower.FrameTagRx

class byteblowerll.byteblower.FrameTagRx(*args, **kwargs)

The FrameTagRx class describes the receive configuration of a Tag in a Frame.

ByteBlower supports optional tagging of frames. Such a tag can have different formats, locations, … These parameters can be set and retrieved using this class.

Currently, two different types of FrameTags are supported:

• Sequence Number: A tag which contains the sequence number within the stream.
• Timestamp: A tag containing the timestamp this frame has left the transmit interface.

Adding tags is a very powerful and flexible feature of ByteBlower. Please have a look at ByteBlower API Knowledgebase: Background: Adding FrameTags to your ByteBlower frame - structure and behaviour for a detailed explanation.

This class is represents the FrameTag configuration at the receiving side of the flow.

In typical situations this configuration must not be changed.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

DescriptionGet(*args)	Gets a textual description for the current object
FormatDefaultSet()	Sets the format to the native, default format.
FormatDestroy()
FormatGet()
FormatSet(fromFrameTagFormat)
FormatSetFromString(formatString)	Method to set the format by name.
FormatStringGet()
MetricsDefaultSet()	Sets the metrics to the default values.
MetricsDestroy()
MetricsGet()
MetricsSet(fromFrameTagMetrics)	Sets the metric of the tag.
ParentGet()	Returns the parent object.
PositionDefaultSet()	This restores the position to the default value.
PositionGet()	Returns the current configured location of the tag within the Frame.
PositionSet(newPosition)	Sets the location of the tag in the Frame.
Refresh()	Retrieves the latest data from the server for this object.
TypeGet()
__init__(*args, **kwargs)	Initialize self.

Attributes

thisown

The membership flag