Kamaelia docs : Kamaelia.Util.RangeFilter.RangeFilter

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.

Outboxes

  • outbox : items in range
  • signal : Shutdown signalling

Methods defined here

__init__(self, ranges)

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

canStop(self)

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.

handleControl(self)

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(self)

Main loop

mustStop(self)

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

waitSend(self, data, boxname)

Generator.

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.

Feedback

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, 19 Oct 2008 at 14:29:09 UTC/GMT

This is a page from the Kamaelia website. You can find the original here: