Package flumotion :: Package manager :: Module component :: Class FeederSet
[show private | hide private]
[frames | no frames]

Class FeederSet

Loggable --+
           |
          FeederSet


I represent a collection of Feeders within a flow. I know when a feeder is ready and I handle dependencies between feeders.
Method Summary
  __init__(self, flow)
  __getitem__(self, key)
  addFeeders(self, componentAvatar)
Add the feeders of the given component to the set.
  dependComponentOnFeeder(self, componentAvatar, feederName, func)
Make the given component dependent on the given feeder.
  feederSetReadiness(self, feederName, readiness)
Set the given feeder to the given readiness.
  getFeeder(self, feederName)
  hasFeeder(self, feederName)
  isFeederReady(self, feederName)
  removeFeeders(self, componentAvatar)
Remove the feeders of the given component to the set.
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, message)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.

Class Variable Summary
str logCategory: Implementors can provide a category to log their messages under.

Method Details

__init__(self, flow)
(Constructor)

Parameters:
flow
           (type=string)

addFeeders(self, componentAvatar)

Add the feeders of the given component to the set.
Parameters:
componentAvatar
           (type=flumotion.manager.component.ComponentAvatar)

dependComponentOnFeeder(self, componentAvatar, feederName, func)

Make the given component dependent on the given feeder. Register a function and arguments to call when the feeder's readiness changes.
Parameters:
componentAvatar - the component to make dependant
           (type=flumotion.manager.component.ComponentAvatar)
feederName - the name of the feeder to depend upon
func - function to run when feeder changes readiness. function takes (readiness, ComponentAvatar)

feederSetReadiness(self, feederName, readiness)

Set the given feeder to the given readiness.

removeFeeders(self, componentAvatar)

Remove the feeders of the given component to the set.
Parameters:
componentAvatar
           (type=flumotion.manager.component.ComponentAvatar)

Class Variable Details

logCategory

Implementors can provide a category to log their messages under.
Type:
str
Value:
'feederset'                                                            

Generated by Epydoc 2.1 on Wed Feb 16 07:22:59 2005 http://epydoc.sf.net