Eclipse.org|
Eclipse.org |
filter | Device Kit |
<filter> element |
Device Kit Attributes Elements XML Reference |
Examples: filter examples
| Name | Description | Use |
|---|---|---|
| <description> | Description of the filter. | 0 to 1 |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. | 0 to 1 |
| <specreference> | Specification reference for this filter. | 0 to unbounded |
| <bytes> | Specifies the message filter (Bit off - ignore, Bit on - compare). | 1 to unbounded |
| Sibling Name | Sibling Description |
|---|---|
| <dkml> | Specifies the root element of a Device Kit <b>D</b>evice <b>K</b>it <b>L</b>anguage (dkml) document. |
| <message> | |
| <parameter> | |
| <block> |  Defines a block.
|
| <constantblock> | Defines a constant block.
|
| <reserveblock> | Defines a reserve block.
|
| <versionblock> | Defines a version block.
|
| <idblock> | Defines a id block.
|
| <identifierblock> | Defines a identifierblock block.
|
| <typeblock> | Defines a type block.
|
| <countblock> | Defines a count block.
|
| <lengthblock> | Defines a length in bits block.
The contents of the block is the length in bits.
|
| <sizeblock> | Defines a length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <segmentlengthblock> | Defines a segment length in bits block.
The contents of the block is the length in bits.
|
| <segmentsizeblock> | Defines a segment length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <messagelengthblock> | Defines a message length in bits block.
The contents of the block is the length in bits.
|
| <messagesizeblock> | Defines a message length in bytes block.
The contents of the block is the length in bytes(each byte is 8 bits).
|
| <bytesparameter> | Defines a bytes parameter.
|
| <bitsparameter> | Defines a bits parameter.
|
| <multiparameter> | Defines a multi parameter.
|
| <variablelengthparameter> | Defines a variable length parameter.
|
| <listparameter> | Defines a list parameter.
|
| <mapparameter> | Defines a map parameter.
|
| <arrayparameter> | Defines a array parameter.
|
| <utf8stringparameter> | Defines a UTF-8 string parameter.
|
| <stringparameter> | Defines a string parameter.
|
| <booleanparameter> | Defines a binary boolean parameter.
Normally, a boolean parameter length should not be longer than 1 bit.
|
| <numberparameter> | |
| <integerparameter> | Defines a binary integer parameter.
An integer parameter length should not be longer than 32 bits (4 bytes).
|
| <unsignedintegerparameter> | Defines a binary unsigned integer parameter.
An unsigned integer parameter length should not be longer than 32 bits (4 bytes).
|
| <longparameter> | Defines a binary long parameter.
An long parameter length should not be longer than 64 bits (8 bytes).
|
| <unsignedlongparameter> | Defines a binary unsigned long parameter.
An unsigned long parameter length should not be longer than 64 bits (8 bytes).
|
| <shortparameter> | Defines a binary short parameter.
An short parameter length should not be longer than 16 bits (2 bytes).
|
| <unsignedshortparameter> | Defines a binary unsigned short parameter.
An unsigned short parameter length should not be longer than 16 bits (2 bytes).
|
| <byteparameter> | Defines a binary byte parameter.
An byte parameter length should not be longer than 8 bits (1 byte).
|
| <unsignedbyteparameter> | Defines a binary unsigned byte parameter.
An unsigned byte parameter length should not be longer than 8 bits (1 byte).
|
| <floatparameter> | Defines a binary IEEE 754 floating-point single 32 bit parameter.
The float parameter length should be 32 bits (4 bytes).
|
| <doubleparameter> | Defines a binary IEEE 754 floating-point double 64 bit parameter.
The double parameter length should be 64 bits (8 bytes).
|
| <segment> | |
| <parametersegment> | |
| <singleparametersegment> | |
| <choicesegment> | |
| <protocol> | |
| <transport> | |
| <transporttest> | |
| <receiver> | Defines a receiver.
|
| <value> | |
| <description> | Specifies the filters description. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for this group of filters. |
| <key> | Specifies a unique filter 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. |
| ¦-<adapter> | Specifies an adapter. |
| ¦ ¦-<command> | Defines a command supported by this concrete device. |
| ¦ ¦ ¦-<message> | Specifies the message to execute the command. |
| ¦ ¦ ¦ ¦-<filter> | Specifies the message filter. |
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the filter. |
| ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this filter. |
| ¦ ¦ ¦ ¦ ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<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. |
| ¦ ¦ ¦ ¦ ¦-<bytes> | Specifies the message filter (Bit off - ignore, Bit on - compare). |
| ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦-<signal> | Specifies the signal to listen. (see signal) |
| ¦ ¦ ¦ ¦ ¦-<messages> | Specifies the messages to trigger the signal. |
| ¦ ¦ ¦ ¦ ¦ ¦-<message> | Specifies the message.(see message) |
| ¦ ¦ ¦-<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 concrete 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) |
| ¦-<receivertest> | Specifies a receiver transport test.
|
| ¦ ¦-<send> | Specifies the message(s) to send during the test.(see send) |
| ¦-<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) 2008 IBM. See license in Legal section. | 2008-02-07 | Device Kit XML Reference 1.1.0 |