Eclipse.org|
Eclipse.org |
customparameter | Device Kit |
<customparameter> element |
Device Kit Attributes Elements XML Reference |
Examples: customparameter 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 |
| name | string | The name/key of the custom variable. | optional |
| type | "boolean" "boolean[]" "byte" "byte[]" "char" "char[]" "double" "double[]" "float" "float[]" "int" "int[]" "long" "long[]" "short" "short[]" "String" | Required. The type of the custom variable. | required |
| defaultvalue | string | The default value to assign the variable. | optional |
| required | boolean | Specifies if required by the configuration. | optional |
| access | boolean | If true, a class field, get method, and set method will be generated for the variable. If not specified, the default is true (changed in Version 1.2.0). | 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 | Description | Use |
|---|---|---|
| <description> | Description of the custom parameter. | 0 to unbounded |
| <history> |  Specifies the custom parameter history. | 0 to unbounded |
| <displayname> | Description of the custom parameter. | 0 to unbounded |
| <units> | Specifies the custom parameter 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 custom parameter. | 0 to unbounded |
| <enum> | Specifies a enumeration option configuration. | 0 to unbounded |
| <minimum> | Specifies the minimum value. | 0 to 1 |
| <maximum> | Specifies the maximum value. | 0 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <description> | Description of the adapter. |
| <history> | Specifies the adapter history. |
| <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. |
| <spec> | Hardware specification documentation for this adapter. |
| <specreference> | Specification reference for this adapter. |
| <multiplex> | Specifies that this is a multiplex adapter. |
| <bundle> | Specifies an Open Services Gateway Initiative (OSGi) bundle should be created. |
| <managedbundle> | Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created. |
| <managedfactorybundle> | Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created. |
| 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. |
| ¦ ¦ ¦-<description> | Description of the custom parameter. |
| ¦ ¦ ¦-<history> | Specifies the custom parameter history.
|
| ¦ ¦ ¦ ¦-<description> | Description of the history.(see description) |
| ¦ ¦ ¦ ¦-<provider> | Specifies the provider history. |
| ¦ ¦ ¦ ¦-<version> | Version of the history documentation. |
| ¦ ¦ ¦-<displayname> | Description of the custom parameter. |
| ¦ ¦ ¦-<units> | Specifies the custom parameter 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 custom parameter.(see specreference) |
| ¦ ¦ ¦-<enum> | Specifies a enumeration option configuration. |
| ¦ ¦ ¦ ¦-<description> | Description of the enumeration.(see description) |
| ¦ ¦ ¦ ¦-<history> | Specifies the enumeration history.(see history) |
| ¦ ¦ ¦ ¦-<units> | Specifies the enum units.(see units) |
| ¦ ¦ ¦ ¦-<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.
|
| ¦ ¦ ¦-<minimum> | Specifies the minimum value. |
| ¦ ¦ ¦-<maximum> | Specifies the maximum value. |
| ¦ ¦-<device> | Specifies the device used by the adapter. |
| ¦ ¦ ¦-<customparameter> | Specifies a custom parameter for this device.(see customparameter) |
| ¦ ¦ ¦-<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) |
| ¦-<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) |
| ¦ ¦-<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) |
| ¦ ¦-<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 |