Eclipse.org|
Eclipse.org |
enum | Device Kit |
<enum> element |
Device Kit Attributes Elements XML Reference |
Examples: enum 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 |
| 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 |
| name | Name | Specifies a name for this element. Normally, if the name attribute is not specified, then the id attribute is used for the name of the element. Since the name attribute value is used by the code generator to generate field and method names, no spaces, periods or commas should be used. | optional |
| Name | Description | Use |
|---|---|---|
| <description> | Description of the enumeration. | 0 to unbounded |
| <history> |  Specifies the enumeration history. | 0 to unbounded |
| <units> | Specifies the enum 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 enumeration. | 0 to unbounded |
| <key> | Specifies a enumeration key. | 0 to 1 |
| <label> | Specifies a enumeration label. | 0 to 1 |
| <value> | Specifies the enumeration value. | 0 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <description> | Description of the configuration. |
| <history> | Specifies the configuration history. |
| <units> | Specifies the configuration units. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for this configuration. |
| <minimum> | Specifies the minimum value. |
| <maximum> | Specifies the maximum value. |
| 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. |
| ¦-<adapter> | Specifies an adapter. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this adapter. |
| ¦ ¦ ¦-<enum> | Specifies a enumeration option configuration. |
| ¦ ¦ ¦ ¦-<description> | Description of the enumeration. |
| ¦ ¦ ¦ ¦-<history> | Specifies the enumeration history.
|
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the history.(see description) |
| ¦ ¦ ¦ ¦ ¦-<provider> | Specifies the provider history. |
| ¦ ¦ ¦ ¦ ¦-<version> | Version of the history documentation. |
| ¦ ¦ ¦ ¦-<units> | Specifies the enum 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 enumeration.(see specreference) |
| ¦ ¦ ¦ ¦-<key> | Specifies a enumeration key. |
| ¦ ¦ ¦ ¦-<label> | Specifies a enumeration label. |
| ¦ ¦ ¦ ¦-<value> | Specifies the enumeration value. |
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the value.(see description) |
| ¦ ¦ ¦ ¦ ¦-<history> | Specifies the value history.(see history) |
| ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this value.(see specreference) |
| ¦ ¦ ¦ ¦ ¦-<ascii> | Specifies a set of ASCII characters (8 bits) value.
|
| ¦ ¦ ¦ ¦ ¦-<bigdecimal> | Specifies an BigDecimal value.
|
| ¦ ¦ ¦ ¦ ¦-<biginteger> | Specifies an BigInteger value.
|
| ¦ ¦ ¦ ¦ ¦-<boolean> | Specifies a Boolean value. |
| ¦ ¦ ¦ ¦ ¦-<byte> | Specifies a Byte value (8 bits). |
| ¦ ¦ ¦ ¦ ¦-<bytes> | Specifies bytes. |
| ¦ ¦ ¦ ¦ ¦-<character> | Specifies a character value (16 bits). |
| ¦ ¦ ¦ ¦ ¦-<double> | Specifies a Double value. |
| ¦ ¦ ¦ ¦ ¦-<float> | Specifies a Float value. |
| ¦ ¦ ¦ ¦ ¦-<int> | Specifies an Integer value (32 bits). |
| ¦ ¦ ¦ ¦ ¦-<list> | Specifies list data. |
| ¦ ¦ ¦ ¦ ¦-<long> | Specifies a Long value (64 bits). |
| ¦ ¦ ¦ ¦ ¦-<map> | Specifies a Map value. |
| ¦ ¦ ¦ ¦ ¦-<short> | Specifies a Short value (16 bits). |
| ¦ ¦ ¦ ¦ ¦-<string> | Specifies a String value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<encoding> | Specifies string encoding.
|
| ¦ ¦-<command> | Defines a command supported by this concrete device. |
| ¦ ¦ ¦-<configuration> | Defines this command as a configuration command. |
| ¦ ¦ ¦ ¦-<enum> | Specifies a enumeration option configuration.(see enum) |
| ¦ ¦ ¦-<data> | Specifies the data to execute the command. |
| ¦ ¦ ¦ ¦-<enum> | Specifies a enumeration.(see enum) |
| ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦-<commands> | Specifies a command group. |
| ¦ ¦ ¦-<configuration> | Defines this command as a configuration command.(see configuration) |
| ¦ ¦ ¦-<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) |
| ¦ ¦ ¦-<group> | Specifies a group.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this group. |
| ¦ ¦ ¦ ¦-<configuration> | Defines this measurement as a configuration measurement.(see configuration) |
| ¦ ¦ ¦ ¦-<data> | Specifies the measurement data.(see data) |
| ¦ ¦ ¦ ¦-<readcommand> | Specifies the command to request a read of the current value of the measurement. |
| ¦ ¦ ¦ ¦ ¦-<configuration> | Defines this command as a configuration command.(see configuration) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<writecommand> | Specifies the command to request a change of the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<configuration> | Defines this command as a configuration command.(see configuration) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<configuration> | Defines this signal as a configuration signal.(see configuration) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data when the signal triggers.(see data) |
| ¦ ¦ ¦ ¦ ¦-<signal> | Specifies the signal to listen. (see signal) |
| ¦ ¦ ¦-<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. |
| ¦ ¦ ¦-<customparameter> | Specifies a custom parameter for this device.(see customparameter) |
| ¦ ¦ ¦-<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. |
| ¦ ¦ ¦ ¦-<customparameter> | Specifies a custom parameter.(see customparameter) |
| ¦ ¦ ¦ ¦-<connection> | Specifies an connection to be used by the transport. |
| ¦ ¦ ¦ ¦ ¦-<customparameter> | Specifies a custom parameter for this connection.(see customparameter) |
| ¦-<adaptertest> | Specifies an adapter test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this adapter test.(see customparameter) |
| ¦ ¦-<adapter> | Specifies the adapter to be tested.(see adapter) |
| ¦-<agent> | Specifies an agent. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this agent.(see customparameter) |
| ¦ ¦-<agentmodel> | Specifies the agent model used by the agent. |
| ¦ ¦ ¦-<customparameter> | Specifies a custom parameter for this agent model.(see customparameter) |
| ¦ ¦ ¦-<device> | Specifies the device used by the agent model.(see device) |
| ¦ ¦-<device> | Specifies the device used by the agent.(see device) |
| ¦ ¦-<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) |
| ¦-<agentmodel> | Specifies the agent model used by the agent.(see agentmodel) |
| ¦-<agenttest> | Specifies an agent test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this agent test.(see customparameter) |
| ¦ ¦-<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. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this concrete device.(see customparameter) |
| ¦ ¦-<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 concrete device.(see transport) |
| ¦-<concretetest> | Specifies a concrete test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this concrete device test.(see customparameter) |
| ¦ ¦-<concrete> | Specifies the concrete device to be tested.(see concrete) |
| ¦-<connection> | Specifies an connection.(see connection) |
| ¦-<connectiontest> | Specifies an connection test. |
| ¦ ¦-<connection> | Specifies the connection to be tested.(see connection) |
| ¦-<device> | Specifies a device.(see device) |
| ¦-<devicetest> | Specifies a device test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this device test.(see customparameter) |
| ¦ ¦-<device> | Specifies the device to be tested.(see device) |
| ¦-<profile> | Specifies a profile. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this profile.(see customparameter) |
| ¦ ¦-<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. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this profile test.(see customparameter) |
| ¦ ¦-<profile> | Specifies the profile to be tested.(see profile) |
| ¦-<testagent> | Specifies a test agent. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this test.(see customparameter) |
| ¦ ¦-<profile> | Specifies the profile to be tested.(see profile) |
| ¦-<receivertest> | Specifies a receiver transport test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this receiver test.(see customparameter) |
| ¦-<transport> | Specifies a transport.(see transport) |
| ¦-<transporttest> | Specifies a transport test. |
| ¦ ¦-<customparameter> | Specifies a custom parameter for this transport test.(see customparameter) |
| ¦ ¦-<transport> | Specifies the transport to be tested.(see transport) |
| Copyright (c) 2009 IBM. See license in Legal section. | 2009-01-22 | Device Kit XML Reference 1.2.0 |