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.Chooser.ForwardIteratingChooser

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


class ForwardIteratingChooser(Axon.Component.component)

Chooser([items]) -> new Chooser component.

Iterates through an iterable set of items. Step by sending "NEXT" messages to its "inbox" inbox.

Keyword arguments: - items -- iterable source of items to be chosen from (default=[])

Inboxes

Outboxes

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

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

getCurrentChoice(self)

Return the current choice

gotoNext(self)

Advance the choice forwards one.

Returns True if successful or False if unable to (eg. already at end).

main(self)

Main loop.

shutdown(self)

Returns True if a shutdownMicroprocess message was received.

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