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)
For examples and more explanations, see the module level docs.
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.
Inboxes
Outboxes
- outbox : items in range
- 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, 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, 05 Jun 2009 at 03:01:38
UTC/GMT
