Kamaelia docs : Kamaelia.BaseIPC

Kamaelia.BaseIPC

For example

Base IPC class. Subclass it to create your own IPC classes.

When doing so, make sure you set the following:

Its doc string, so a string explanation can be generated for an instance of your subclass.
'Parameters' class attribute to a list of named parameters you accept at creation, prefixing optional parameters with "?", e.g. "?depth"

For example

A custom IPC class to report a theft taking place!

class Theft(Kamaelia.BaseIPC.IPC):
    """Something has been stolen!"""

    Parameters = ["?who","what"]

So what happens when we use it?

>>> ipc = Theft(who="Sam", what="sweeties")
>>> ipc.__doc__
'Something has been stolen!'
>>> ipc.who
'Sam'
>>> ipc.what
'sweeties'

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, 23 Jul 2008 at 03:02:36 UTC/GMT

(C) 2005 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved,
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.