Eclipse.org|
Eclipse.org |
pid | Device Kit |
<pid> element |
Device Kit Attributes Elements XML Reference |
Examples: pid 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 | "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 |
| Name | Description | Use |
|---|---|---|
| <description> | Description of the parameter identifier (PID). | 0 to unbounded |
| <history> |  Specifies the parameter identifier (PID) history. | 0 to unbounded |
| <units> | Specifies the parameter identifier (PID) 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 parameter identifier (PID). | 0 to unbounded |
| <key> | Specifies the parameter identifier (pid) key. | 0 to 1 |
| <identifier> | Specifies the parameter identifier. | 0 to 1 |
| <length> | Specifies the parameter (pid) data length in bits. | 1 to 1 |
| <size> | Specifies the parameter identifier (pid) size in bytes. See the length element to specify the parameter (pid) data length in bits. | 1 to 1 |
| <minimum> | Specifies the minimum value. | 1 to 1 |
| <maximum> | Specifies the maximum value. | 1 to 1 |
| <negative> | Negate the parameter value. | 1 to 1 |
| <not> | Logical not of a boolean value. | 1 to 1 |
| <scale> | Specifies the value to scale the parameter value. | 1 to 1 |
| <shift> | Specifies the value to shift the parameter value. | 1 to 1 |
| <translate> | Specifies the value to add (translate) to the parameter value. | 1 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <messages> | Specifies the messages to trigger the signal. |
| <description> | Specifies the pids description. |
| <history> | Specifies the pids history. |
| <units> | Specifies the pids units. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for pids. |
| <key> | Specifies the unique pids key. |
| 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. |
| ¦-<pids> | Specifies the defined pids. |
| ¦ ¦-<pid> | Specifies the pid. |
| ¦ ¦ ¦-<description> | Description of the parameter identifier (PID). |
| ¦ ¦ ¦-<history> | Specifies the parameter identifier (PID) history.
|
| ¦ ¦ ¦ ¦-<description> | Description of the history.(see description) |
| ¦ ¦ ¦ ¦-<provider> | Specifies the provider history. |
| ¦ ¦ ¦ ¦-<version> | Version of the history documentation. |
| ¦ ¦ ¦-<units> | Specifies the parameter identifier (PID) 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. |
| ¦ ¦ ¦ ¦-<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> | 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 this parameter identifier (PID).(see specreference) |
| ¦ ¦ ¦-<key> | Specifies the parameter identifier (pid) 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> | 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> | 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> | 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. |
| ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦-<pid> | Specifies the pid for this signal.(see pid) |
| ¦ ¦ ¦-<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. |
| ¦ ¦ ¦-<pids> | Specifies the defined pids.(see pids) |
| ¦ ¦ ¦-<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. |
| ¦ ¦-<pids> | Specifies the defined pids.(see pids) |
| ¦ ¦-<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 |