Eclipse.org Eclipse.org
XML Element

<filter> element

Device Kit Attributes Elements XML Reference
Use the filter tag to specify a filter mask for a message. The bytes tag defines the relevant filter bytes. All of the bits in the filter bytes that are turned on will be compared and all bits that are turned off will be ignored.

Examples: filter examples


NameDescriptionUse
Element <filter> elements
<description>Description of the filter.0 to 1
<deprecated>New 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 NameSibling Description
Element <filter> element siblings
<description>Specifies the filters description.
<deprecated>New 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 NameElement Description
Element <filter> element tree
<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.
¦  ¦  ¦  ¦--<filter>Specifies the message filter.
¦  ¦  ¦  ¦  ¦--<description>Description of the filter.
¦  ¦  ¦  ¦  ¦--<deprecated>New 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>New 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>New 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.
¦  ¦  ¦  ¦  ¦--<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)
¦  ¦  ¦  ¦  ¦--<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 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