Class which represents the metrics of a Tag. More...
Methods | |
| Alignment.Get | |
| Returns the alignment value for this tag. More... | |
| Description.Get | |
| Returns a textual description of the object. | |
| Length.Get | |
| Returns the length of the tag. More... | |
| Parent.Get | |
| Returns the parent object. | |
Class which represents the metrics of a Tag.
The metrics of a tag are parameters describing the length and byte alignment of a frame.
The metrics can only be read, because they are determined by the tag format and the server type.
| FrameTag.Metrics::Alignment.Get |
Returns the alignment value for this tag.
Some frame tags must be aligned with the start of a frame. This means the tag must start at a multiple of <x> bytes within a frame, where <x> is the alignment value. The default value is one.
Frame alignment requirements are caused by hardware limitations as a new tag must be included in every frame that is sent.
1
This example illustrates how the alingment value of a timestamp tag can be retrieved;
Returns:
1
| FrameTag.Metrics::Length.Get |
Returns the length of the tag.
The number of bytes in a Frame that will be overwritten by this tag.
Note that this byte range does not need to be contiguous! More specifically, if the tag alignment is larger than one, a single byte containing the offset to the aligned tag may be stored separately.
This example shows the how to retrieve the length of a sequence tag:
Returns:
8
