Eclipse.org Eclipse.org
XML Element

<data> element

Device Kit Attributes Elements XML Reference
The data tag specifies a data within a message. By using the data tag, the value of the data can be extracted from the message received from the hardware device. The data tag is also used to define how to stored a data 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 data include those that specify where to place the data within the message and a series of transforms that manipulate the data's data. You can set the units of the data with the units tag.

Examples: data examples


NameTypeDescriptionUse
Element <data> attributes
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

NameDescriptionUse
Element <data> elements
<description>Description of the data.0 to 1
<deprecated>New 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
<length>Specifies the data length in bits. See the length 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
<units>Specifies the optional data units.0 to 1

Sibling NameSibling Description
Element <data> element siblings
<message>Specifies the message to execute the command.
<method>Specifies the method to execute the command.

Element NameElement Description
Element <data> element tree
<dkml>Specifies the root element of a Device Kit Device Kit Language (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.
¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦  ¦  ¦  ¦--<specreference>Specification reference for this data.
¦  ¦  ¦  ¦  ¦--<description>Description of the specification reference.(see description)
¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦--<spec>The hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the specification.(see description)
¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦--<speccomment>Comment about the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<specdate>Date of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<spectitle>Title of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<specvendor>Vendor the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<specversion>Version of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦--<specsection>The reference to section in the hardware specification documentation.
¦  ¦  ¦  ¦--<key>Specifies the data key.
¦  ¦  ¦  ¦--<length>Specifies the data length in bits. See the length 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.
¦  ¦  ¦  ¦--<units>Specifies the optional data units.
¦  ¦  ¦  ¦  ¦--<description>Description of the units.(see description)
¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this units.(see specreference)
¦  ¦--<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)
¦  ¦  ¦--<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 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)
¦--<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) IBM 2007. Device Kit XML Reference 1.0.0