Eclipse.org|
Eclipse.org |
data | Device Kit |
<data> element |
Device Kit Attributes Elements XML Reference |
Examples: data examples
| Name | Type | Description | Use |
|---|---|---|---|
| id | ID | Specifies an unique identifier for this element. After defining an element with the id attribute, other elements can reference this element by using the idref attribute. Since the id attribute value is used by the code generator to generate field and method names, no spaces, periods or commas should be used. | optional |
| implementation | Name | Specifies the implementation class name. | optional |
| idref | IDREF | Specifies a reference to the element with the matching id attribute. The matching id attribute must be specified before the idref attribute can be used. | optional |
| type | "bit" "boolean" "boolean[]" "byte" "byte[]" "bytes" "double" "double[]" "float" "float[]" "int" "int[]" "long" "long[]" "short" "string" "ubyte" "ubytes" "uint" "ulong" "ushort" "Array" "List" "Map" "Number" "FloatingPoint" | Specifies the data type. | optional |
| name | Name | Specifies a name for this element. Normally, if the name attribute is not specified, then the id attribute is used for the name of the element. Since the name attribute value is used by the code generator to generate field and method names, no spaces, periods or commas should be used. | optional |
| Name | Description | Use |
|---|---|---|
| <description> | Description of the data. | 0 to unbounded |
| <history> |  Specifies the data history. | 0 to unbounded |
| <optional> | Defines if this data item is optional. | 0 to 1 |
| <units> | Specifies the data units. | 0 to 1 |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. | 0 to 1 |
| <specreference> | Specification reference for this data. | 0 to unbounded |
| <key> | Specifies the data key. | 0 to 1 |
| <enum> | Specifies a enumeration. | 0 to unbounded |
| <length> | Specifies the data length in bits. See the size element to specify the data length in bytes. | 1 to 1 |
| <size> | Specifies the data size in bytes. See the length element to specify the data length in bits. | 1 to 1 |
| <minimum> | Specifies the minimum value. | 1 to 1 |
| <maximum> | Specifies the maximum value. | 1 to 1 |
| <data> | Specifies the data to execute the command. | 0 to unbounded |
| Sibling Name | Sibling Description |
|---|---|
| <message> | Specifies the message to execute the command. |
| <method> | Specifies the method to execute the command. |
| <description> | Description of the data. |
| <history> | Specifies the data history. |
| <optional> | Defines if this data item is optional. |
| <units> | Specifies the data units. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for this data. |
| <key> | Specifies the data key. |
| <enum> | Specifies a enumeration. |
| 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. |
| ¦-<adapter> | Specifies an adapter. |
| ¦ ¦-<command> | Defines a command supported by this concrete device. |
| ¦ ¦ ¦-<data> | Specifies the data to execute the command. |
| ¦ ¦ ¦ ¦-<description> | Description of the data. |
| ¦ ¦ ¦ ¦-<history> | Specifies the data history.
|
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the history.(see description) |
| ¦ ¦ ¦ ¦ ¦-<provider> | Specifies the provider history. |
| ¦ ¦ ¦ ¦ ¦-<version> | Version of the history documentation. |
| ¦ ¦ ¦ ¦-<optional> | Defines if this data item is optional. |
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the optional item.(see description) |
| ¦ ¦ ¦ ¦ ¦-<history> | Specifies the optional history.(see history) |
| ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this optional item. |
| ¦ ¦ ¦ ¦ ¦ ¦-<description> | Description of the specification reference.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦-<spec> | The protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<description> | Description of the specification.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<history> | Specifies the specification history.(see history) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<speccomment> | Comment about the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specdate> | Date of the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<spectitle> | Title of the protoocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specurl> | Url of the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specvendor> | Vendor of the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specversion> | Version of the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦-<specsection> | The reference to section in the protocol specification documentation. |
| ¦ ¦ ¦ ¦-<units> | Specifies the data units. |
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the units.(see description) |
| ¦ ¦ ¦ ¦ ¦-<history> | Specifies the units history.(see history) |
| ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this units.(see specreference) |
| ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦-<specreference> | Specification reference for this data.(see specreference) |
| ¦ ¦ ¦ ¦-<key> | Specifies the data key. |
| ¦ ¦ ¦ ¦-<enum> | Specifies a enumeration.
|
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the enumeration.(see description) |
| ¦ ¦ ¦ ¦ ¦-<history> | Specifies the enumeration history.(see history) |
| ¦ ¦ ¦ ¦ ¦-<units> | Specifies the enum units.(see units) |
| ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this enumeration.(see specreference) |
| ¦ ¦ ¦ ¦ ¦-<key> | Specifies a enumeration key.(see key) |
| ¦ ¦ ¦ ¦ ¦-<label> | Specifies a enumeration label. |
| ¦ ¦ ¦ ¦ ¦-<value> | Specifies the enumeration value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<description> | Description of the value.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦-<history> | Specifies the value history.(see history) |
| ¦ ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this value.(see specreference) |
| ¦ ¦ ¦ ¦ ¦ ¦-<ascii> | Specifies a set of ASCII characters (8 bits) value.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<bigdecimal> | Specifies an BigDecimal value.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<biginteger> | Specifies an BigInteger value.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<boolean> | Specifies a Boolean value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<byte> | Specifies a Byte value (8 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦-<bytes> | Specifies bytes. |
| ¦ ¦ ¦ ¦ ¦ ¦-<character> | Specifies a character value (16 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦-<double> | Specifies a Double value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<float> | Specifies a Float value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<int> | Specifies an Integer value (32 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦-<list> | Specifies list data. |
| ¦ ¦ ¦ ¦ ¦ ¦-<long> | Specifies a Long value (64 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦-<map> | Specifies a Map value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<short> | Specifies a Short value (16 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦-<string> | Specifies a String value. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<encoding> | Specifies string encoding.
|
| ¦ ¦ ¦ ¦-<length> | Specifies the data length in bits. See the size element to specify the data length in bytes. |
| ¦ ¦ ¦ ¦-<size> | Specifies the data size in bytes. See the length element to specify the data length in bits. |
| ¦ ¦ ¦ ¦-<minimum> | Specifies the minimum value. |
| ¦ ¦ ¦ ¦-<maximum> | Specifies the maximum value. |
| ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦-<commands> | Specifies a command group. |
| ¦ ¦ ¦-<command> | Specifies the command within the group of commands.(see command) |
| ¦ ¦-<group> | Defines a group supported by this concrete device. |
| ¦ ¦ ¦-<command> | Specifies a command that is supported by this group.(see command) |
| ¦ ¦ ¦-<commands> | Specifies a command group.(see commands) |
| ¦ ¦ ¦-<group> | Specifies a group.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this group. |
| ¦ ¦ ¦ ¦-<data> | Specifies the measurement data.(see data) |
| ¦ ¦ ¦ ¦-<readcommand> | Specifies the command to request a read of the current value of the measurement. |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<writecommand> | Specifies the command to request a change of the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data when the signal triggers.(see data) |
| ¦ ¦ ¦ ¦ ¦-<signal> | Specifies the signal to listen. (see signal) |
| ¦ ¦ ¦-<signal> | Specifies a signal supported by this group.(see signal) |
| ¦ ¦-<measurement> | Defines a measurement supported by this concrete device.(see measurement) |
| ¦ ¦-<signal> | Defines a signal supported by this concrete device.(see signal) |
| ¦ ¦-<device> | Specifies the device used by the adapter. |
| ¦ ¦ ¦-<command> | Specifies a command that is supported by this device.(see command) |
| ¦ ¦ ¦-<commands> | Specifies a command group.(see commands) |
| ¦ ¦ ¦-<group> | Defines a group supported by this device.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this device.(see measurement) |
| ¦ ¦ ¦-<signal> | Specifies a signal supported by this device.(see signal) |
| ¦-<adaptertest> | Specifies an adapter test. |
| ¦ ¦-<adapter> | Specifies the adapter to be tested.(see adapter) |
| ¦-<agent> | Specifies an agent. |
| ¦ ¦-<agentmodel> | Specifies the agent model used by the agent. |
| ¦ ¦ ¦-<device> | Specifies the device used by the agent model.(see device) |
| ¦ ¦-<device> | Specifies the device used by the agent.(see device) |
| ¦ ¦-<command> | Specifies a command that is supported by this device.(see command) |
| ¦ ¦-<commands> | Specifies a command group.(see commands) |
| ¦ ¦-<group> | Defines a group supported by this device.(see group) |
| ¦ ¦-<measurement> | Specifies a measurement supported by this device.(see measurement) |
| ¦ ¦-<signal> | Specifies a signal supported by this device.(see signal) |
| ¦-<agentmodel> | Specifies the agent model used by the agent.(see agentmodel) |
| ¦-<agenttest> | Specifies an agent test. |
| ¦ ¦-<agent> | Specifies the agent to be tested.(see agent) |
| ¦ ¦-<agentmodeltest> | Specifies the agent model test. |
| ¦ ¦ ¦-<agentmodel> | Specifies the agent model to be tested.(see agentmodel) |
| ¦-<agentmodeltest> | Specifies an agent model test.(see agentmodeltest) |
| ¦-<concrete> | Specifies a concrete device. |
| ¦ ¦-<command> | Defines a command supported by this concrete device.(see command) |
| ¦ ¦-<commands> | Specifies a command group.(see commands) |
| ¦ ¦-<group> | Defines a group supported by this concrete device.(see group) |
| ¦ ¦-<measurement> | Defines a measurement supported by this concrete device.(see measurement) |
| ¦ ¦-<signal> | Defines a signal supported by this concrete device.(see signal) |
| ¦-<concretetest> | Specifies a concrete test. |
| ¦ ¦-<concrete> | Specifies the concrete device to be tested.(see concrete) |
| ¦-<device> | Specifies a device.(see device) |
| ¦-<devicetest> | Specifies a device test. |
| ¦ ¦-<device> | Specifies the device to be tested.(see device) |
| ¦-<profile> | Specifies a profile. |
| ¦ ¦-<command> | Specifies a command that is supported by this profile.(see command) |
| ¦ ¦-<commands> | Specifies a command group.(see commands) |
| ¦ ¦-<group> | Defines a group supported by this profile.(see group) |
| ¦ ¦-<measurement> | Specifies a measurement supported by this profile.(see measurement) |
| ¦ ¦-<signal> | Specifies a signal supported by this profile.(see signal) |
| ¦ ¦-<adapter> | Specifies the adapter used by the profile.(see adapter) |
| ¦ ¦-<device> | Specifies the device used by the profile.(see device) |
| ¦-<profiletest> | Specifies a profile test. |
| ¦ ¦-<profile> | Specifies the profile to be tested.(see profile) |
| ¦-<testagent> | Specifies a test agent. |
| ¦ ¦-<profile> | Specifies the profile to be tested.(see profile) |
| Copyright (c) 2009 IBM. See license in Legal section. | 2009-01-22 | Device Kit XML Reference 1.2.0 |