Kamaelia docs : Kamaelia.Util.Chooser.ForwardIteratingChooser

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

  • control : shutdown messages
  • inbox : receive commands

Outboxes

  • outbox : emits chosen items
  • signal : shutdown messages

Methods defined here

__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, 19 Oct 2008 at 14:29:09 UTC/GMT

This is a page from the Kamaelia website. You can find the original here: