Eclipse.org Eclipse.org pids Device Kit
XML Element 

<pids> element

 Device Kit Attributes Elements XML Reference
The pids tag enables you to define the set of pid supported. The idref attribute references the pids in the pids tag. The value of ""idref"" corresponds to the id of a previously defined pids.

Examples: pids examples


NameTypeDescriptionUse
Element <pids> 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 <pids> elements
<description>Specifies the pids description.0 to unbounded
<history>New Specifies the pids history.0 to unbounded
<units>Specifies the pids units.0 to 1
<deprecated>Specifies that the contents of this element should be marked as deprecated.0 to 1
<specreference>Specification reference for pids.0 to unbounded
<key>Specifies the unique pids key.0 to 1
<pid>Specifies the pid.1 to unbounded

Sibling NameSibling Description
Element <pids> element siblings
<description>Description of a Device Kit Markup Language (dkml) element.
<deprecated>Specifies that the contents of this element should be marked as deprecated.
<provider>Specifies the provider.
<version>Specifies the current version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.
<vendor>Specifies an implementing vendor.
<incubation>If the contents of this element is true, then this is an incubation project.

Element NameElement Description
Element <pids> 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.
¦-<pids>Specifies the defined pids.
¦ ¦-<description>Specifies the pids description.
¦ ¦-<history>New Specifies the pids history.
¦ ¦ ¦-<description>Description of the history.(see description)
¦ ¦ ¦-<provider>Specifies the provider history.
¦ ¦ ¦-<version>Version of the history documentation.
¦ ¦-<units>Specifies the pids 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.
¦ ¦ ¦-<specreference>Specification reference for this units.
¦ ¦ ¦ ¦-<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.
¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦-<specreference>Specification reference for pids.(see specreference)
¦ ¦-<key>Specifies the unique pids key.
¦ ¦-<pid>Specifies the pid.
¦ ¦ ¦-<description>Description of the parameter identifier (PID).(see description)
¦ ¦ ¦-<history>New Specifies the parameter identifier (PID) history.(see history)
¦ ¦ ¦-<units>Specifies the parameter identifier (PID) units.(see units)
¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦-<specreference>Specification reference for this parameter identifier (PID).(see specreference)
¦ ¦ ¦-<key>Specifies the parameter identifier (pid) key.(see key)
¦ ¦ ¦-<identifier>Specifies the parameter identifier.
¦ ¦ ¦-<length>Specifies the parameter (pid) data length in bits.
¦ ¦ ¦-<size>Specifies the parameter identifier (pid) size in bytes. See the length element to specify the parameter (pid) data length in bits.
¦ ¦ ¦-<minimum>Specifies the minimum value.
¦ ¦ ¦-<maximum>Specifies the maximum value.
¦ ¦ ¦-<negative>Negate the parameter value.
¦ ¦ ¦-<not>Logical not of a boolean value.
¦ ¦ ¦-<scale>Specifies the value to scale the parameter value.
¦ ¦ ¦ ¦-<description>Description of the scale.(see description)
¦ ¦ ¦ ¦-<history>New Specifies the scale history.(see history)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this scale.(see specreference)
¦ ¦ ¦-<shift>Specifies the value to shift the parameter value.
¦ ¦ ¦ ¦-<description>Description of the shift.(see description)
¦ ¦ ¦ ¦-<history>New Specifies the shift history.(see history)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this shift.(see specreference)
¦ ¦ ¦-<translate>Specifies the value to add (translate) to the parameter value.
¦ ¦ ¦ ¦-<description>Description of the translate.(see description)
¦ ¦ ¦ ¦-<history>New Specifies the translate history.(see history)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this translate.(see specreference)
¦-<adapter>Specifies an adapter.
¦ ¦-<device>Specifies the device used by the adapter.
¦ ¦ ¦-<pids>Specifies the defined pids.(see pids)
¦-<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.
¦ ¦-<pids>Specifies the defined pids.(see pids)
¦-<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.
¦ ¦-<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