python.IndexAssociation Namespace Reference

Functions
	IndexAssociation (parent, assoctool, target, prefix='', level=0, blockname=None, allowMissing=False, containerIndexName='', **kw)

Variables
	D3PD = CompFactory.D3PD

Function Documentation

IndexAssociation()

python.IndexAssociation.IndexAssociation	(		parent,
			assoctool,
			target,
			prefix = '',
			level = 0,
			blockname = None,
			allowMissing = False,
			containerIndexName = '',
		**	kw )

Helper for setting up an association via an index.

parent: The parent D3PDobject or block.
assoctool: The class for the (single) association tool.
target: The label for the getter within which we look up the index.
prefix: Prefix to add to the contained variables, if any.
level: Level of detail for the block.
blockname: Name for the block.
allowMissing: If true, then it is not considered an error for the
              target getter to fail to find the input objects.

Extra arguments are passed to the association tool.

Definition at line 17 of file IndexAssociation.py.

                      **kw):
 
    """Helper for setting up an association via an index.
 
    parent: The parent D3PDobject or block.
    assoctool: The class for the (single) association tool.
    target: The label for the getter within which we look up the index.
    prefix: Prefix to add to the contained variables, if any.
    level: Level of detail for the block.
    blockname: Name for the block.
    allowMissing: If true, then it is not considered an error for the
                  target getter to fail to find the input objects.
 
    Extra arguments are passed to the association tool.
"""
 
    if blockname is None:
        blockname = assoctool.__name__
 
    def maker (name, prefix, object_name, **kw2):
        this_target = target
        if 'target' in kw2:
            this_target = kw2['target']
            del kw2['target']
 
        if this_target == '':
            this_target = []
        elif not isinstance(this_target, list):
            this_target = [ this_target ]
 
        assoc = assoctool (name + 'Assoc', **kw2)
        filler = D3PD.ContainedAssociationFillerTool \
                 (name, Prefix = prefix, Associator = assoc, Matched = '')
        indexer = D3PD.IndexFillerTool \
                  (name + 'Index', 
                   Targets = this_target,
                   ContainerIndexName = containerIndexName,
                   AllowMissing = allowMissing)
        filler.BlockFillers += [indexer]
        filler += [indexer]
        return filler
 
    obj = D3PDObject (maker, prefix)
    parent.defineBlock (level, blockname, obj, **kw)
    return obj

Variable Documentation

D3PD

python.IndexAssociation.D3PD = CompFactory.D3PD

Definition at line 14 of file IndexAssociation.py.