April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Axon.CoordinatingAssistantTracker.coordinatingassistanttracker

For examples and more explanations, see the module level docs.


class coordinatingassistanttracker(object)

coordinatingassistanttracker([parent]) -> new coordinatingassistanttracker object.

Co-ordinating assistant tracker object tracks values and (component,inboxname) services under names.

Keyword arguments:

  • parent -- Optional. None, or a parent coordinatingassistanttracker object.

Methods defined here

__init__(self[, parent])

deRegisterService(self, service)

Deregister a service that was previously registered.

Raises Axon.AxonExceptions.MultipleServiceDeletion if the service is not/ no longer registered.

informationItemsLogged(self)

Returns list of names values are being tracked under.

main(self)

registerService(self, service, thecomponent, inbox)

Register a named inbox on a component as willing to offer a service with the specified name.

Keyword arguments:

  • service -- the name for the service
  • thecomponent -- the component offering the service
  • inbox -- name of the inbox on the component

Exceptions that may be raised:

retrieveService(self, name)

Retrieve the (component, inboxName) service with the specified name.

retrieveValue(self, name)

Retrieve the value tracked (recorded) under the specified name.

Trying to retrieve a value under a name that isn't yet being tracked results in an Axon.AxonExceptions.AccessToUndeclaredTrackedVariable exception being raised.

servicesRegistered(self)

Returns list of names of registered services

trackValue(self, name, value)

Track (record) the specified value under the specified name.

Once we start tracking a value, we have it's value forever (for now). Trying to track the same named value more than once causes an Axon.AxonExceptions.NamespaceClash exception. This is done to capture problems between interacting components

updateValue(self, name, value)

Update the value being tracked under the specified name with the new value provided.

Trying to update a value under a name that isn't yet being tracked results in an Axon.AxonExceptions.AccessToUndeclaredTrackedVariable exception being raised.

zap(self)

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, 09 Dec 2009 at 04:00:25 UTC/GMT