Kamaelia docs : Kamaelia.Util.TestResult

Basic Result Tester

A simple component for testing that a stream of data tests true. This is NOT intended for live systems, but for testing and development purposes only.

Example Usage

::
Pipeline( source(), TestResult() ).activate()

Raises an assertion error if source() generates a value that doesn't test true.

How does it work?

If the component receives a value on its "inbox" inbox that does not test true, then an AssertionError is raised.

If the component receives a StopSystem message on its "control" inbox then a StopSystemException message is raised as an exception.

This component does not terminate (unless it throws an exception).

It does not pass on the data it receives.


Kamaelia.Util.TestResult.TestResult

class TestResult(Axon.Component.component)

TestResult() -> new TestResult.

Component that raises an AssertionError if it receives data on its "inbox" inbox that does not test true. Or raises a StopSystemException if a StopSystem message is received on its "control" inbox.

Inboxes

  • control : StopSystemException messages
  • inbox : Data to test

Outboxes

  • outbox : NOT USED
  • signal : NOT USED

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.

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


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)