python.ReaderAlg.ReaderAlg Class Reference

A class very similar to D3PDMakerCoreComps.MakerAlg, but it creates a configured version of the D3PD::ReaderAlg. More...

Inheritance diagram for python.ReaderAlg.ReaderAlg:

Collaboration diagram for python.ReaderAlg.ReaderAlg:

Public Member Functions
def	__init__ (self, name, seq=topSequence, tuplename=None, preD3PDAlgSeqName=D3PDMakerFlags.PreD3PDAlgSeqName(), **kwargs)
def	__iadd__ (self, configs)

Public Attributes
	filterSeq
	Prefix

Private Member Functions
def	_setRegistry (self, conf)

Private Attributes
	__logger
	_registry

Detailed Description

A class very similar to D3PDMakerCoreComps.MakerAlg, but it creates a configured version of the D3PD::ReaderAlg.

Should not be used directly, users should only use the specialized functions from D3PDMakerReader.CodeGenerators.

Definition at line 18 of file ReaderAlg.py.

Constructor & Destructor Documentation

__init__()

def python.ReaderAlg.ReaderAlg.__init__	(		self,
			name,
			seq = topSequence,
			tuplename = None,
			preD3PDAlgSeqName = D3PDMakerFlags.PreD3PDAlgSeqName(),
		**	kwargs
	)

Definition at line 20 of file ReaderAlg.py.

    def __init__( self,
                  name,
                  seq = topSequence,
                  tuplename = None,
                  preD3PDAlgSeqName = D3PDMakerFlags.PreD3PDAlgSeqName(),  # noqa: B008 (constant string)
                  **kwargs ):
 
        self.__logger = logging.getLogger( "ReaderAlg" )
 
        # Work around initialization order issue.
        seq.__iadd__( D3PDMakerCoreComps.DummyInitAlg( name + 'DummyInit' ),
                      index = 0 )
 
        # tuple name defaults to the algorithm name.
        if tuplename is None:
            tuplename = name
 
        # Create the algorithm Configurable.
        D3PD__ReaderAlg.__init__ ( self, name,
                                   TupleName = tuplename,
                                   **kwargs )
 
        # Add to the supplied sequence.
        if seq:
            # But first, add a sequence for algorithms that should run
            # before D3PD making, if it's not already there.
            preseq = AlgSequence( preD3PDAlgSeqName )
            if not hasattr( seq, preD3PDAlgSeqName ):
                seq += [ preseq ]
 
            # We don't want to do filtering in the presequence.
            preseq.StopOverride = True
            # Now set up another sequence for filtering.
            # Unlike the presequence, there should be a unique one of these
            # per algorithm.  We also need to break out an additional
            # sequence to which users can add, and to wrap the whole
            # thing in a sequence to prevent a failed filter
            # decision from stopping other algorithms.
            # Like this:
            #
            #   ALG_FilterAlgorithmsWrap (StopOverride = True)
            #     ALG_FilterAlgorithmsHolder
            #       ALG_FilterAlgorithms
            #       ALG
            #     Dummy alg, to reset filter flag
            suffix = D3PDMakerFlags.FilterAlgSeqSuffix()
            wrap = AlgSequence( name + suffix + 'Wrap',
                                StopOverride = True )
            holder = AlgSequence( name + suffix + 'Holder' )
            self.filterSeq = AlgSequence( name + suffix )
            holder += self.filterSeq
            holder += self
            wrap += holder
            wrap += PyAthena.Alg( name + 'Dummy' )
           
            seq += wrap
 
        # Create a unique collection getter registry tool for this tree.
        from AthenaCommon.AppMgr import ToolSvc
        self._registry = \
           D3PDMakerCoreComps.CollectionGetterRegistryTool (self.name() +
                                                   '_CollectionGetterRegistry')
        ToolSvc += self._registry
 
        return
 

Member Function Documentation

__iadd__()

def python.ReaderAlg.ReaderAlg.__iadd__	(		self,
			configs
	)

Add a new IObjFillerTool to a tree.

Definition at line 86 of file ReaderAlg.py.

    def __iadd__( self, configs ):
        """Add a new IObjFillerTool to a tree."""
 
        # FIXME: should make sure name is unique within alg.
        if not isinstance( configs, list ):
            self.Prefix = configs.Prefix
            configs = [ configs ]
        else:
            self.__logger.warning( "Should only add single D3PDObject-s to algorithm!" )
        self.Tools += configs
        super( ReaderAlg, self ).__iadd__( configs )
 
        # Rescan all children to set the proper collection getter registry.
        self._setRegistry( self )
#        for c in self.getChildren()[ nchild: ]:
#            D3PDObject.runHooks( c )
 
        return self
 

_setRegistry()

def python.ReaderAlg.ReaderAlg._setRegistry (   self,   conf  )

private

Scan CONF and all children to set the proper
collection getter registry for this tree.

Definition at line 105 of file ReaderAlg.py.

    def _setRegistry( self, conf ):
        """Scan CONF and all children to set the proper
        collection getter registry for this tree.
        """
       
        if 'CollectionGetterRegistry' in conf.properties():
            conf.CollectionGetterRegistry = self._registry
        for c in conf.getAllChildren():
            self._setRegistry( c )
 
        return

Member Data Documentation

__logger

python.ReaderAlg.ReaderAlg.__logger

private

Definition at line 22 of file ReaderAlg.py.

_registry

python.ReaderAlg.ReaderAlg._registry

private

Definition at line 74 of file ReaderAlg.py.

filterSeq

python.ReaderAlg.ReaderAlg.filterSeq

Definition at line 64 of file ReaderAlg.py.

Prefix

python.ReaderAlg.ReaderAlg.Prefix

Definition at line 91 of file ReaderAlg.py.

---

The documentation for this class was generated from the following file:

• ReaderAlg.py