|
|
method | Device Kit |
<method> element |
Device Kit Attributes Elements XML Reference |
Content type: string
Examples: method 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 |
| format | "binary" "decimal" "hex" "octal" | Specifies the numeric format base of data. For instance, if the protocol''s specification are in hexadecimal format, this attribute should be set to ""hex"". | 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 |
| Sibling Name | Sibling Description |
|---|---|
| <message> | Specifies the message to execute the command. |
| <data> | Specifies the data to execute the command. |
| 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. |
| ¦ ¦-<command> | Defines a command supported by this concrete device. |
| ¦ ¦ ¦-<method> | Specifies the method to execute the command. |
| ¦ ¦-<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) |
| ¦ ¦ ¦-<group> | Specifies a group.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this group. |
| ¦ ¦ ¦ ¦-<readcommand> | Specifies the command to request a read of the current value of the measurement. |
| ¦ ¦ ¦ ¦ ¦-<method> | Specifies the method to execute the command.(see method) |
| ¦ ¦ ¦ ¦-<writecommand> | Specifies the command to request a change of the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<method> | Specifies the method to execute the command.(see method) |
| ¦ ¦ ¦ ¦-<method> | Specifies the method.(see method) |
| ¦ ¦ ¦ ¦-<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<method> | Specifies the method to handle the signal.(see method) |
| ¦ ¦ ¦ ¦ ¦-<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. |
| ¦ ¦ ¦-<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) |
| ¦-<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) |
| ¦ ¦-<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. |
| ¦ ¦-<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) |
| ¦-<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. |
| ¦ ¦-<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. |
| ¦ ¦-<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 |