IndexMultiAssociation.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 
#
# @file D3PDMakerCoreComps/python/IndexMultiAssociation.py
# @author scott snyder <snyder@bnl.gov>
# @author Ryan Reece <ryan.reece@cern.ch>
# @date Dec 2009
# @brief Helper for setting up an association via an index.
#
 
 
from .D3PDObject import D3PDObject
from AthenaConfiguration.ComponentFactory import CompFactory
 
D3PD = CompFactory.D3PD
 
 
def IndexMultiAssociation (parent,
                           assoctool,
                           target,
                           prefix = '',
                           level = 0,
                           blockname = None,
                           allowMissing = False,
                           nrowName = 'n',
                           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,
            or a list of such labels if multiple targets are desired.
    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.
    nrowName: Name of the variable for the count of objects.
              Omitted if empty.
 
    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.ContainedVectorMultiAssociationFillerTool \
                 (name,
                  Prefix = prefix,
                  Associator = assoc,
                  NrowName = nrowName)
        indexer = D3PD.IndexFillerTool \
                  (name + 'Index', 
                   Targets = this_target,
                   ContainerIndexName = containerIndexName,
                   AllowMissing = allowMissing)
        filler.BlockFillers += [indexer]
        return filler
 
    obj = D3PDObject (maker, prefix)
    parent.defineBlock (level, blockname, obj, **kw)
    return obj