Home

About, Index, Changes

Developers

 

 
 
 
 
 

Documentation Notes

A check list

The purpose of this page is to act as an index (think index of a book) to the documentation that's been written. It also allows us to see what documentation still needs writing. This is *ALOT* of documentation. I'll produce a template for component/module documentation shortly.

In the spirit of NaNoWriMo, we're spending November getting the documentation up to date for the RELEASE trees.

Axon/

sss

Axon/Axon

  • __init__.py -- UNCHECKED --
  • AdaptiveCommsComponent.py -- UNCHECKED --
    • AdaptiveCommsComponent
  • AxonExceptions.py -- UNCHECKED --
    • AxonException
    • normalShutdown
    • invalidComponentInterface
    • noSpaceInBox
    • BadParentTracker
    • ServiceAlreadyExists
    • BadComponent
    • BadInbox
    • MultipleServiceDeletion
    • NamespaceClash
    • AccessToUndeclaredTrackedVariable
    • ArgumentsClash
  • Axon.py -- UNCHECKED --
    • AxonObject
  • Component.py -- UNCHECKED --
    • component
  • CoordinatingAssistantTracker.py -- UNCHECKED --
    • coordinatingassistanttracker
  • debugConfigDefaults.py -- UNCHECKED --
  • debugConfigFile.py -- UNCHECKED --
  • debug.py -- UNCHECKED --
    • debug
  • idGen.py -- UNCHECKED --
    • idGen
  • Ipc.py -- UNCHECKED --
    • ipc
    • WaitComplete
    • reactivate
    • newComponent
    • shutdownMicroprocess
    • notify
    • status
    • wouldblock
    • producerFinished
    • errorInformation
  • Linkage.py -- UNCHECKED --
    • linkage
  • Microprocess.py -- UNCHECKED --
    • microprocess
  • Postman.py -- UNCHECKED --
    • postman
  • Scheduler.py -- UNCHECKED --
    • scheduler
  • ThreadedComponent.py -- UNCHECKED --
    • threadedcomponent
  • util.py -- UNCHECKED --
    • Finality

Axon/Axon/test

  • AxonTest.py -- UNCHECKED --
    • VerboseTestResults
    • suite
    • FixedTestProgram
    • AddNameToVerboseTextString
  • TemplateTestModule.py -- UNCHECKED --
    • classWeAreTesting_Test
  • test_AdaptiveCommsComponent.py -- UNCHECKED --
    • AdaptiveCommsComponent_Test
  • test_Axon.py -- UNCHECKED --
    • Axon_Test
  • test_Component.py -- UNCHECKED --
    • TComponent
    • TComponentAsync
    • TestMainLoopComponent
    • closeDownCompTestException
    • TestMainLoopComponentClosedown
    • dummylinkage
    • testpostman
    • testpostman2
    • Component_Test
  • test_CoordinatingAssistantTracker.py -- UNCHECKED --
    • dummyComponent
    • CoordinatingAssistantTracker_Test
  • test_debugConfigFile.py -- UNCHECKED --
    • classWeAreTesting_Test
  • test_debug.py -- UNCHECKED --
    • classWeAreTesting_Test
  • test_idGen.py -- UNCHECKED --
    • classWeAreTesting_Test
  • test_Ipc.py -- UNCHECKED --
    • ipc_Test
    • newComponent_Test
    • shutdownMicroprocess_Test
    • notify_Test
    • status_Test
    • wouldblock_Test
    • producerFinished_Test
    • errorInformation_Test
  • test_Linkage.py -- UNCHECKED --
    • DummyPostman
    • TestComponent
    • linkage_Test
  • test_Microprocess.py -- UNCHECKED --
    • MicroProcess_Test
  • test_Postman.py -- UNCHECKED --
    • named
    • AdvancedMockLinkage
    • AdvancedMockLinkage2
    • postman_Test
  • test_Scheduler.py -- UNCHECKED --
    • scheduler_Test
  • test___str__.py -- UNCHECKED --
    • str_Test
  • test_util.py -- UNCHECKED --
    • util_Test

Kamaelia/

  • afortune.pl
  • __init__.py
  • KamaeliaExceptions.py
    • socketSendFailure
    • connectionClosedown
    • connectionDied
    • connectionDiedSending
    • connectionDiedReceiving
    • connectionServerShutdown
    • BadRequest
  • KamaeliaIPC.py
    • socketShutdown
    • newCSA
    • shutdownCSA
    • newServer
  • MimeRequestComponent.py
    • MimeRequestComponent
  • ReadFileAdaptor.py
    • ReadFileAdaptor
  • SampleTemplateComponent.py
    • myComponent
  • SimpleServerComponent.py
  • SingleServer.py
  • vorbisDecodeComponent.py

Kamaelia/Tools

  • axonshell.py -- UNCHECKED --
  • AxonVisualiser.py -- UNCHECKED --
  • VisualPipeBuilder.py -- UNCHECKED --

Kamaelia/Tools/PipeBuilder

  • BuildViewer.py
    • ComponentParticle
  • GUI.py
    • ArgumentsPanel
    • BuilderControlsGUI
    • TextOutputGUI
  • PipeBuild.py
    • PipeBuild
  • PipelineWriter.py
    • PipelineWriter

Kamaelia/Kamaelia/Data

  • README
  • __init__.py
  • Escape.py
  • MimeDict.py
  • MimeObject.py
  • Rationals.py
  • requestLine.py

Kamaelia/Kamaelia/Data/Tests

  • test_Escape.py
  • test_MimeDict.py
  • test_Rationals.py
  • Kamaelia/Kamaelia/Chassis
    • __init__.py
    • Prefab.py
    • ConnectedServer.py
    • Carousel.py

    Kamaelia/Kamaelia/Chassis/test

    • test_Carousel.py
  • Kamaelia/Kamaelia/Codec
    • Dirac.py
    • __init__.py
    • RawYUVFramer.py

    Kamaelia/Kamaelia/File

    • __init__.py
    • Reading.py
    • Writing.py

    Kamaelia/Kamaelia/Internet

    • __init__.py
    • ConnectedSocketAdapter.py
    • Multicast_receiver.py
    • Multicast_sender.py
    • Multicast_transceiver.py
    • Selector.py
    • TCPClient.py
    • TCPServer.py
    • ThreadedTCPClient.py

    Kamaelia/Kamaelia/Internet/test

    • test_BasicMulticastSystem.py
    • test_MulticastTransceiverSystem.py
    • test_TCPServerClientSystem.py
  • Kamaelia/Kamaelia/Internet/Simulate
    • __init__.py
    • BrokenNetwork.py

    Kamaelia/Kamaelia/Physics

    • Behaviours.py
    • __init__.py

    Kamaelia/Kamaelia/Physics/Simple

    • __init__.py
    • MultipleLaws.py
    • Particle.py
    • ParticleSystem.py
    • SimpleLaws.py
    • SpatialIndexer.py

    Kamaelia/Kamaelia/Protocol

    • __init__.py
    • SpatialIndexer.py
  • Kamaelia/Kamaelia/Sketch

    • Empty on release tree, candidate for deletion in practice

    Kamaelia/Kamaelia/Support

    Candidate for being moved to somewhere else

    Kamaelia/Kamaelia/test

    Needs a revamp (BADLY - probably also moving out of this directory - probably up )

    • README
    • debug.conf
    • SynchronousLinks_SystemTest.py
    • test_ConsoleEcho.py
    • test_MimeRequestComponent.py
    • test_Selector.py

    Kamaelia/Kamaelia/UI

    • __init__.py
    • PygameDisplay.py

    Kamaelia/Kamaelia/UI/Pygame

    • __init__.py
    • BasicSprite.py
    • Button.py
    • EventHandler.py
    • Image.py
    • KeyEvent.py
    • Multiclick.py
    • SpriteScheduler.py
    • Ticker.py
    • VideoOverlay.py

    Kamaelia/Kamaelia/UI/Tk

    • __init__.py
    • TkWindow.py

    Kamaelia/Kamaelia/UI/MH

    • __init__.py
    • DragHandler.py
    • PyGameApp.py

    Kamaelia/Kamaelia/Util

    • __init__.py
    • Chargen.py
    • Chooser.py
    • Comparator.py
    • ConsoleEcho.py
    • Fanout.py
    • FilterComponent.py
    • Graphline.py
    • Introspector.py
    • LossyConnector.py
    • MarshallComponent.py
    • Marshalling.py
    • NullSinkComponent.py
    • passThrough.py
    • PipelineComponent.py
    • RateFilter.py
    • Splitter.py
    • TestResultComponent.py
    • ToStringComponent.py

    Kamaelia/Kamaelia/Util/test

    • test_Chooser.py
    • test_Comparator.py
    • test_ForwardIteratingChooser.py
    • test_LossyConnector.py
    • test_Marshalling.py
    • test_RateControl.py
    • test_Splitter.py
    • test_TestResultComponent.py
    • test_VariableRateControl.py

    Kamaelia/Kamaelia/Visualisation

    • __init__.py

    Kamaelia/Kamaelia/Visualisation/Axon

    • __init__.py
    • AxonLaws.py
    • AxonVisualiserServer.py
    • ExtraWindowFurniture.py
    • PComponent.py
    • PPostbox.py

    Kamaelia/Kamaelia/Visualisation/PhysicsGraph

    • __init__.py
    • chunks_to_lines.py
    • GridRenderer.py
    • lines_to_tokenlists.py
    • ParticleDragger.py
    • RenderingParticle.py
    • TopologyViewerComponent.py
    • TopologyViewerServer.py

    Kamaelia/Examples

  • ...

    • Kamaelia/Examples/example1

    • README
    • FortuneCookie_ServerClient.py

    Kamaelia/Examples/example2

    • README
    • SimpleStreamingSystem.py

    Kamaelia/Examples/example3

    • README
    • SimpleStreamer.py
    • SimpleStreamingClient.py

    Kamaelia/Examples/example4

    • README
    • MulticastStreamingClient.py
    • MulticastStreamingServer.py
    • MulticastStreamingSystem.py
    • MulticastStreamingSystem_SRM.py

    Kamaelia/Examples/example5

    • README
    • IntrospectingSimpleStreamingSystem.py
  • Kamaelia/Examples/example6
    • TopologyVisualiser.py

    Kamaelia/Examples/example7

    • BasicGraphVisualisation.py

    Kamaelia/Examples/example7/BasicGraphVisualisation

    • __init__.py
    • ParticleDragger.py
    • PhysApp1.py
    • VisibleParticle.py

    Kamaelia/Examples/example8

    • README
    • Slides/
      • Collection of 6 pictures 800x600
    • slideshow.py
    • topology.py
    • topology_slideshow.py

    Kamaelia/Examples/example9

    • pictures/
      • Collection of small pictures
    • banner.gif
    • cat.gif
    • Simplegame.py
    • hold.wav
    • KDE_Beep_Bottles.wav

    Kamaelia/Examples/example10

    • snowboard-jum-352x288x75.dirac.drc
    • SimpleDiracEncodeDecode.py
    • SimpleDiracPlayer.py

    Kamaelia/Examples/example11

    • Ulysses
    • Ticker.py

    Kamaelia/Examples/example12

    • SimpleMultiFileStreamer.py
    • ClientStreamToFile.py

     

    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)