Eclipse.org Eclipse.org messages Device Kit

XML Element 

<messages> element

Device Kit Attributes Elements XML Reference
Specifies a group of messages.

Examples: messages examples


NameTypeDescriptionUse
Element <messages> attributes
idIDSpecifies 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
implementationNameSpecifies the implementation class name.optional
idrefIDREFSpecifies 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

NameDescriptionUse
Element <messages> elements
<description>Specifies the messages description.0 to unbounded
<history>New Specifies the messages history.0 to unbounded
<deprecated>Specifies that the contents of this element should be marked as deprecated.0 to 1
<specreference>Specification reference for this group of messages.0 to unbounded
<key>Specifies the unique messages key.0 to 1
<message>Specifies the message.1 to unbounded

Sibling NameSibling Description
Element <messages> element siblings
<pid>Specifies the pid for this signal.

Element NameElement Description
Element <messages> element tree
<dkml>Specifies the root element of a Device Kit &lt;b&gt;D&lt;/b&gt;evice &lt;b&gt;K&lt;/b&gt;it &lt;b&gt;L&lt;/b&gt;anguage (dkml) document.
¦-<adapter>Specifies an adapter.
¦ ¦-<group>Defines a group supported by this concrete device.
¦ ¦ ¦-<group>Specifies a group.(see group)
¦ ¦ ¦-<measurement>Specifies a measurement supported by this group.
¦ ¦ ¦ ¦-<signal>Specifies the signal containing the measurement value.
¦ ¦ ¦ ¦ ¦-<signal>Specifies the signal to listen. (see signal)
¦ ¦ ¦ ¦ ¦-<messages>Specifies the messages to trigger the signal.
¦ ¦ ¦ ¦ ¦ ¦-<description>Specifies the messages description.
¦ ¦ ¦ ¦ ¦ ¦-<history>New Specifies the messages history.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the history.(see description)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<provider>Specifies the provider history.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<version>Version of the history documentation.
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.
¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this group of messages.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<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>New 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.
¦ ¦ ¦ ¦ ¦ ¦-<key>Specifies the unique messages key.
¦ ¦ ¦ ¦ ¦ ¦-<message>Specifies the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the message.(see description)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<history>New Specifies the message history.(see history)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this message.(see specreference)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<ascii>Specifies a set of ASCII characters (8 bits) within the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<bytes>Specifies a set of bytes. Each byte is 8 bits within the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<nibbles>Specifies a set of nibbles. Each nibble is 4 bits within the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<string>New Specifies a set of string characters within the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<encoding>New Specifies string encoding.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<utf8>Specifies a set of UTF-8 characters within the message.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<tokens>Specifies the message tokens.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<parameters>Specifies a group of parameters.
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<description>Specifies the parameters description.(see description)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<history>New Specifies the parameters history.(see history)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<units>Specifies the parameters units.
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the units.(see description)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<history>New 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 group of parameters.(see specreference)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<key>Specifies the unique parameters key.(see key)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<parameters>Specifies the parameters.(see parameters)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<filter>Specifies the message filter.
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the filter.(see description)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<history>New Specifies the filter history.(see history)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this filter.(see specreference)
¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<bytes>Specifies the message filter (Bit off - ignore, Bit on - compare).(see bytes)
¦ ¦ ¦ ¦ ¦ ¦ ¦-<sentmessage>Specifies the message that was sent that caused this message.
¦ ¦ ¦-<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.
¦ ¦ ¦-<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)
¦ ¦-<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.
¦ ¦-<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.
¦ ¦-<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