Kamaelia docs : Kamaelia.Util.Filter.Filter

Kamaelia.Util.Filter.Filter

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


class Filter(Axon.Component.component)

Filter([filter]) -> new Filter component.

Component that can modify and filter data passing through it. Plug your own 'filter' into it.

Keyword arguments:

  • filter -- an object implementing a filter(data) method (default=NullFilter instance)

Inboxes

  • control : Shutdown signalling
  • inbox : Data to be filtered

Outboxes

  • outbox : Filtered data
  • signal : Shutdown signalling

Methods defined here

__init__(self[, filter])

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

closeDownComponent(self)

Flush any data remaining in the filter before shutting down.

mainBody(self)

Main loop body.

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: