Eclipse.org
|
|
<parameter> element |
Device Kit Attributes Elements XML Reference |
Examples: parameter examples
| Name | Type | Description | Use |
|---|---|---|---|
| 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. | 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. | 0 to unbounded |
| <key> | Specifies the parameter key. | 0 to 1 |
| <bigendian> | Specifies that the parameter data is in big endian order. This is the default order. | 0 to 1 |
| <field> | Specifies the field parameter name. | 0 to 1 |
| <insert> | Specifies that the parameter should be inserted into the message. | 0 to 1 |
| <littleendian> | Specifies that the parameter data is in little endian order. | 0 to 1 |
| <offset> | Specifies the starting bit offset of the parameter within the message. Offset 0 is the first bit in the message. See the offset element to specify the parameter offset in bytes. | 1 to 1 |
| <index> | Specifies the starting byte index of the parameter within the message. Index 0 is the first byte of the message. See the offset element to specify the parameter offset in bits. | 1 to 1 |
| <length> | Specifies the parameter length in bits. See the length element to specify the parameter length in bytes. | 1 to 1 |
| <size> | Specifies the parameter size in bytes. See the length element to specify the parameter length in bits. | 1 to 1 |
| <enum> | Specifies a enum for this parameter. | 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 |
| <units> | Specifies the optional parameter units. | 0 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <parameters> | Specifies a group of parameters. |
| <description> | Specifies the parameters description. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for this group of parameters. |
| <key> | Specifies the unique parameters key. |
| Element Name | Element Description |
|---|---|
| <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. |
| ¦ ¦ ¦--<message> | Specifies the message to execute the command. |
| ¦ ¦ ¦ ¦--<parameter> | Specifies a parameter within the message. |
| ¦ ¦ ¦ ¦ ¦--<description> | Description of the parameter. |
| ¦ ¦ ¦ ¦ ¦--<deprecated> | Specifies that the contents of this element should be marked as deprecated.
|
| ¦ ¦ ¦ ¦ ¦--<specreference> | Specification reference for this parameter. |
| ¦ ¦ ¦ ¦ ¦ ¦--<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 hardware specification documentation. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦--<description> | Description of the specification.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦--<deprecated> | 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 parameter key. |
| ¦ ¦ ¦ ¦ ¦--<bigendian> | Specifies that the parameter data is in big endian order. This is the default order. |
| ¦ ¦ ¦ ¦ ¦--<field> | Specifies the field parameter name. |
| ¦ ¦ ¦ ¦ ¦--<insert> | Specifies that the parameter should be inserted into the message. |
| ¦ ¦ ¦ ¦ ¦--<littleendian> | Specifies that the parameter data is in little endian order. |
| ¦ ¦ ¦ ¦ ¦--<offset> | Specifies the starting bit offset of the parameter within the message. Offset 0 is the first bit in the message. See the offset element to specify the parameter offset in bytes. |
| ¦ ¦ ¦ ¦ ¦--<index> | Specifies the starting byte index of the parameter within the message. Index 0 is the first byte of the message. See the offset element to specify the parameter offset in bits. |
| ¦ ¦ ¦ ¦ ¦--<length> | Specifies the parameter length in bits. See the length element to specify the parameter length in bytes. |
| ¦ ¦ ¦ ¦ ¦--<size> | Specifies the parameter size in bytes. See the length element to specify the parameter length in bits. |
| ¦ ¦ ¦ ¦ ¦--<enum> | Specifies a enum for this parameter. |
| ¦ ¦ ¦ ¦ ¦ ¦--<description> | Description of the enum.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦--<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦--<specreference> | Specification reference for this enum.(see specreference) |
| ¦ ¦ ¦ ¦ ¦--<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> | 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> | 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> | 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 units. |
| ¦ ¦ ¦ ¦ ¦ ¦--<description> | Description of the units.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦--<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦--<specreference> | Specification reference for this units.(see specreference) |
| ¦ ¦ ¦ ¦--<parameters> | Specifies a group of parameters. |
| ¦ ¦ ¦ ¦ ¦--<parameter> | Specifies the parameter.(see parameter) |
| ¦ ¦--<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. |
| ¦ ¦ ¦ ¦--<message> | Specifies the measurement message.(see message) |
| ¦ ¦ ¦ ¦--<readcommand> | Specifies the command to request a read of the current value of the measurement. |
| ¦ ¦ ¦ ¦ ¦--<message> | Specifies the message to execute the command.(see message) |
| ¦ ¦ ¦ ¦--<writecommand> | Specifies the command to request a change of the measurement value. |
| ¦ ¦ ¦ ¦ ¦--<message> | Specifies the message to execute the command.(see message) |
| ¦ ¦ ¦ ¦--<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦--<message> | Specifies the message to trigger the signal.(see message) |
| ¦ ¦ ¦ ¦ ¦--<messages> | Specifies the messages to trigger the signal. |
| ¦ ¦ ¦ ¦ ¦ ¦--<message> | Specifies the message.(see message) |
| ¦ ¦ ¦ ¦ ¦--<parameter> | Specifies a message parameter.(see parameter) |
| ¦ ¦ ¦ ¦ ¦--<parameters> | Specifies a parameter group.(see parameters) |
| ¦ ¦ ¦ ¦--<parameter> | Specifies a parameter used to extract/insert the information within
the parent data.(see parameter) |
| ¦ ¦ ¦ ¦--<parameters> | Specifies a group of parameters.(see parameters) |
| ¦ ¦ ¦--<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) |
| ¦ ¦ ¦--<transport> | Specifies the transport used by the device. |
| ¦ ¦ ¦ ¦--<message> | Specifies a transport message.(see message) |
| ¦--<adaptertest> | Specifies an adapter test. |
| ¦ ¦--<send> | Specifies the message(s) to send during the test. |
| ¦ ¦ ¦--<message> | Specifies the message to send.(see message) |
| ¦ ¦--<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. |
| ¦ ¦--<send> | Specifies the message(s) to send during the test.(see send) |
| ¦ ¦--<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) |
| ¦ ¦--<transport> | Specifies the transport used by the device.(see transport) |
| ¦--<concretetest> | Specifies a concrete test. |
| ¦ ¦--<concrete> | Specifies the concrete device to be tested.(see concrete) |
| ¦--<connectiontest> | Specifies an connection test. |
| ¦ ¦--<send> | Specifies the message(s) to send during the test.(see send) |
| ¦--<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. |
| ¦ ¦--<send> | Specifies the message(s) to send during the test.(see send) |
| ¦ ¦--<profile> | Specifies the profile to be tested.(see profile) |
| ¦--<testagent> | Specifies a test agent. |
| ¦ ¦--<profile> | Specifies the profile to be tested.(see profile) |
| ¦--<transport> | Specifies a transport.(see transport) |
| ¦--<transporttest> | Specifies a transport test. |
| ¦ ¦--<send> | Specifies the message(s) to send during the test.(see send) |
| ¦ ¦--<transport> | Specifies the transport to be tested.(see transport) |
| Copyright (c) IBM 2007. | Device Kit XML Reference 1.0.0 |