Kamaelia.Util.FilterComponent.FilterComponent

class FilterComponent(Axon.Component.component)

FilterComponent([filter]) -> new FilterComponent 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, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

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

(C) 2006 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved, 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.