Eclipse.org|
Eclipse.org |
segment | Device Kit |
<segment> element |
Device Kit Attributes Elements XML Reference |
The segment tag specifies a segment
within a message. By using the segment tag, the value
of the segment can be extracted from the message
received from the hardware device. The segment tag is
also used to define how to stored a segment into a
message to be sent to the hardware device. This value in
the message can be translated into/from the application
value by using the translate tags. Valid subtags of
segment include those that specify where to place the
segment within the message and a series of transforms
that manipulate the segment''s data. You can set
the units of the segment with the units tag. Release: 1.1.0
Examples: segment examples
| Name | Type | Description | Use |
|---|---|---|---|
| type | "ascii" "asciiz" "bit" "boolean" "boolean[]" "byte" "byte[]" "bytes" "double" "double[]" "float" "float[]" "hexascii" "hexstring" "int" "int[]" "long" "long[]" "nascii" "nstring" "numericstring" "short" "string" "ubyte" "ubytes" "uint" "ulong" "ushort" | Specifies the data type. | optional |
| Name | Description | Use |
|---|---|---|
| <description> | Description of the segment. | 0 to unbounded |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. | 0 to 1 |
| <specreference> | Specification reference for this segment. | 0 to unbounded |
| <key> | Specifies the segment key. | 0 to 1 |
| <field> | Specifies the field segment name. | 0 to 1 |
| <ascii> | Specifies a set of ASCII characters (8 bits). | 1 to unbounded |
| <bytes> | Specifies a set of bytes. Each byte is 8 bits. | 1 to unbounded |
| <nibbles> | Specifies a set of nibbles. Each nibble is 4 bits. | 1 to unbounded |
| <parameters> | Specifies a group of parameters. | 0 to unbounded |
| <filter> | Specifies the message filter. | 0 to 1 |
| <offset> | Specifies the starting bit offset of the segment within the message. Offset 0 is the first bit in the message. See the index element to specify the segment position in bytes. | 1 to 1 |
| <index> | Specifies the starting byte index of the segment within the message. Index 0 is the first byte of the message. See the offset element to specify the segment offset in bits. | 1 to 1 |
| <length> | Specifies the segment length in bits. See the size element to specify the segment length in bytes. | 1 to 1 |
| <size> | Specifies the segment size in bytes. See the length element to specify the segment length in bits. | 1 to 1 |
| <occursminimum> | Specifies the minimum number of times the seqment can occur.
| 0 to 1 |
| <occursmaximum> | Specifies the maximum number of times the seqment can occur.
| 0 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <dkml> | Specifies the root element of a Device Kit <b>D</b>evice <b>K</b>it <b>L</b>anguage (dkml) document. |
| <filter> | |
| <message> | |
| <parameter> | |
| <block> | Defines a block.
|
| <constantblock> | Defines a constant block.
|
| <reserveblock> | Defines a reserve block.
|
| <versionblock> | Defines a version block.
|
| <idblock> | Defines a id block.
|
| <identifierblock> | Defines a identifierblock block.
|
| <typeblock> | Defines a type block.
|
| <countblock> | Defines a count block.
|
| <lengthblock> | Defines a length in bits block.
The contents of the block is the length in bits.
|
| <sizeblock> | Defines a length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <segmentlengthblock> | Defines a segment length in bits block.
The contents of the block is the length in bits.
|
| <segmentsizeblock> | Defines a segment length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <messagelengthblock> | Defines a message length in bits block.
The contents of the block is the length in bits.
|
| <messagesizeblock> | Defines a message length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <bytesparameter> | Defines a bytes parameter.
|
| <bitsparameter> | Defines a bits parameter.
|
| <multiparameter> | Defines a multiple parameter.
|
| <variablelengthparameter> | Defines a variable length parameter.
|
| <listparameter> | Defines a list parameter.
|
| <mapparameter> | Defines a map parameter.
|
| <arrayparameter> | Defines a array parameter.
|
| <utf8stringparameter> | Defines a UTF-8 string parameter.
|
| <stringparameter> | Defines a string parameter.
|
| <booleanparameter> | Defines a binary boolean parameter.
Normally, a boolean parameter length should not be longer than 1 bit.
|
| <numberparameter> | |
| <integerparameter> | Defines a binary integer parameter.
An integer parameter length should not be longer than 32 bits (4 bytes).
|
| <unsignedintegerparameter> | Defines a binary unsigned integer parameter.
An unsigned integer parameter length should not be longer than 32 bits (4 bytes).
|
| <longparameter> | Defines a binary long parameter.
An long parameter length should not be longer than 64 bits (8 bytes).
|
| <unsignedlongparameter> | Defines a binary unsigned long parameter.
An unsigned long parameter length should not be longer than 64 bits (8 bytes).
|
| <shortparameter> | Defines a binary short parameter.
An short parameter length should not be longer than 16 bits (2 bytes).
|
| <unsignedshortparameter> | Defines a binary unsigned short parameter.
An unsigned short parameter length should not be longer than 16 bits (2 bytes).
|
| <byteparameter> | Defines a binary byte parameter.
An byte parameter length should not be longer than 8 bits (1 byte).
|
| <unsignedbyteparameter> | Defines a binary unsigned byte parameter.
An unsigned byte parameter length should not be longer than 8 bits (1 byte).
|
| <floatparameter> | Defines a binary IEEE 754 floating-point single 32 bit parameter.
The float parameter length should be 32 bits (4 bytes).
|
| <doubleparameter> | Defines a binary IEEE 754 floating-point double 64 bit parameter.
The double parameter length should be 64 bits (8 bytes).
|
| <parametersegment> | |
| <singleparametersegment> | |
| <choicesegment> | |
| <protocol> | |
| <transport> | |
| <transporttest> | |
| <receiver> | Defines a receiver transport.
|
| <value> | |
| Element Name | Element Description |
|---|---|
| <dkml> | Specifies the root element of a Device Kit <b>D</b>evice <b>K</b>it <b>L</b>anguage (dkml) document. |
| Copyright (c) 2008 IBM. See license in Legal section. | 2008-09-10 | Device Kit XML Reference 1.1.0 |