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

Warning!

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[, 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, 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)