Eclipse.org Eclipse.org
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


NameDescriptionUse
Element <pids> elements
<description>Specifies the pids description.0 to 1
<deprecated>New 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>New Specifies that the contents of this element should be marked as deprecated.
<provider>Specifies the provider.
<version>Specifies the 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.
<adapter>Specifies an adapter.
<adaptertest>Specifies an adapter test.
<agent>Specifies an agent.
<agentmodel>Specifies the agent model used by the agent.
<agenttest>Specifies an agent test.
<agentmodeltest>Specifies an agent model test.
<concrete>Specifies a concrete device.
<concretetest>Specifies a concrete test.
<connection>Specifies an connection.
<connectiontest>Specifies an connection test.
<device>Specifies a device.
<devicetest>Specifies a device test.
<profile>Specifies a profile.
<profiletest>Specifies a profile test.
<testagent>Specifies a test agent.
<transport>Specifies a transport.
<transporttest>Specifies a transport test.

Element NameElement Description
Element <pids> element tree
<dkml>Specifies the root element of a Device Kit Device Kit Language (dkml) document.
¦--<pids>Specifies the defined pids.
¦  ¦--<description>Specifies the pids description.
¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦  ¦--<specreference>Specification reference for pids.
¦  ¦  ¦--<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 unique pids key.
¦  ¦--<pid>Specifies the pid.
¦  ¦  ¦--<description>Description of the parameter identifier (PID).(see description)
¦  ¦  ¦--<deprecated>New 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)
¦  ¦  ¦  ¦--<deprecated>New 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)
¦  ¦  ¦  ¦--<deprecated>New 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)
¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦--<specreference>Specification reference for this translate.(see specreference)
¦  ¦  ¦--<units>Specifies the optional parameter identifier (pid) 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)
¦--<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) IBM 2007. Device Kit XML Reference 1.0.0