Kamaelia docs : Kamaelia.Util.RangeFilter.RangeFilter


For examples and more explanations, see the module level docs.

class RangeFilter(Axon.Component.component)

RangeFilter(ranges) -> new RangeFilter component.

Filters out items of the form (value, ...) not within at least one of a specified value set of range. Items within range are passed through.

Keyword arguments:

- ranges  -- list of (low,high) pairs representing ranges of value. Ranges are inclusive.


  • outbox : items in range
  • signal : Shutdown signalling

Methods defined here


You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

__init__(self, ranges)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature


Checks for any shutdown messages arriving at the "control" inbox, and returns true if the component should terminate when it has finished processing any pending data.


Collects any new shutdown messages arriving at the "control" inbox, and ensures self.shutdownMsg contains the highest priority one encountered so far.

inRange(self, index)

Returns one of the ranges that the specified index falls within, otherwise returns None.


Main loop


Checks for any shutdown messages arriving at the "control" inbox, and returns true if the component should terminate immediately.

waitSend(self, data, boxname)


Sends data out of the "outbox" outbox. If the destination is full (noSpaceInBox exception) then it waits until there is space. It keeps retrying until it succeeds.

If the component is ordered to immediately terminate then "STOP" is raised as an exception.


Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)