Package flumotion :: Package wizard :: Module models :: Class Component
[hide private]

Class Component

source code

                 object --+
                          |
extern.log.log.Loggable --+
                          |
                         Component
Known Subclasses:

I am a Component. A component has a name which identifies it and must be unique within a flow. A component has a list of feeders and a list of eaters and must belong to a worker. The feeder list or the eater list can be empty, but not both at the same time.

Instance Methods [hide private]
 
__init__(self, worker=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__repr__(self)
repr(x)
source code
 
validate(self) source code
 
getWorker(self) source code
 
getProperties(self) source code
 
getPlugs(self) source code
 
addPlug(self, plug)
Add a plug to the component
source code
 
link(self, component)
Link two components together
source code
 
unlink(self, component)
Unlink two components from each other
source code
 
getEaters(self)
Get the names of all the eaters for this component
source code
string
getFeederName(self, component)
Get the feeder name a component should use to link to
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from extern.log.log.Loggable: __providedBy__, debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  eaterType = None
restrict the eaters which can be linked with this component to this type
  feederType = None
restrict the feeders which can be linked with this component to this type
  componentType = None
the type of the component, such as ogg-muxer, this is not mandatory in the class, can also be set in the instance.
  isAtmosphereComponent = False
if this component should live in the atmosphere instead of in a flow

Inherited from extern.log.log.Loggable: __implemented__, __provides__, logCategory

Instance Variables [hide private]
  exists
if the component already exists, if this is set to true, a configuration saver or validator might chose to ignore this component
  name
name of the component
Properties [hide private]
  component_type

Inherited from object: __class__

Method Details [hide private]

__init__(self, worker=None)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

addPlug(self, plug)

source code 

Add a plug to the component

Parameters:
  • plug (Plug) - the plug

link(self, component)

source code 

Link two components together

Parameters:
  • component (Component) - component to link with

unlink(self, component)

source code 

Unlink two components from each other

Parameters:
  • component (Component) - component to unlink from

getEaters(self)

source code 

Get the names of all the eaters for this component

Returns:
feeder names

getFeederName(self, component)

source code 

Get the feeder name a component should use to link to

Parameters:
  • component (Component subclass) - the component who links to this
Returns: string
feeder name

Property Details [hide private]

component_type

Get Method:
unreachable.component_type(self)