Kamaelia docs : Kamaelia.Apps.Whiteboard.Entuple


Entuple data

Receives data on its "inbox" inbox; wraps that data inside a tuple, and outputs that tuple from its "outbox" outbox.

Example Usage

Taking console input and sandwiching it in a tuple between the strings ("You" and "said") and ("just" and now"):

Pipeline( ConsoleReader(),
          Entuple(prefix=["You","said"], postfix=["just","now"]),
At runtime::
>>> Hello there!
('You', 'said', 'Hello there!', 'just', 'now')

How does it work?

At initialisation specify a list of items to be placed at the front (prefix) and back (postfix) of the tuples that are output.

When an item of data is received at the "inbox" inbox; it is placed inside a tuple, after the prefixes and before the postfixes. It is then immediately sent out of the "outbox" outbox.

For example: if the prefix is [1,2,3] and the postfix is ['a','b'] and the item of data that arrives is 'flurble' then (1,2,3,'flurble','a','b') will be sent to the "outbox" outbox.

If Entuple receives a shutdownMicroprocess message on its "control" inbox, it will pass it on out of the "signal" outbox. The component will then terminate.


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

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

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. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)