August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

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!

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.