python.PoolAttributeHelper Namespace Reference

Functions
	setPoolAttribute (**kwargs)
	setFileCompAlg (fileName=None, compAlg=None)
	setFileCompLvl (fileName=None, compLvl=None)
	setMaxBufferSize (fileName=None, bufferSize=None)
	setMinBufferEntries (fileName=None, nEntries=None)
	setTreeAutoFlush (fileName=None, treeName=None, autoFlush=None)
	setContainerSplitLevel (fileName=None, treeName=None, splitLvl=None)
	setBranchBasketSize (fileName=None, treeName=None, basketSize=None)

Variables
list	attrs = []
	attrName
	attrValue

Detailed Description

A basic module that helps with setting various common Pool Attributes 

Function Documentation

setBranchBasketSize()

python.PoolAttributeHelper.setBranchBasketSize	(		fileName = None,
			treeName = None,
			basketSize = None )

Convenience method for setting the branch basket size for a tree in a given file. 

Definition at line 76 of file PoolAttributeHelper.py.

def setBranchBasketSize( fileName = None, treeName = None, basketSize = None ):
    """ Convenience method for setting the branch basket size for a tree in a given file. """
 
    return setPoolAttribute( fileName  = fileName,
                             contName  = f"TTree={treeName}",
                             attrName  = "BRANCH_BASKET_SIZE",
                             attrValue = basketSize )
 
# Main Function: Only to check the basic functionality
# Can be run via python PoolAttributeHelper.py

setContainerSplitLevel()

python.PoolAttributeHelper.setContainerSplitLevel	(		fileName = None,
			treeName = None,
			splitLvl = None )

Convenience method for setting the split level for a tree in a given file. 

Definition at line 68 of file PoolAttributeHelper.py.

def setContainerSplitLevel( fileName = None, treeName = None, splitLvl = None ):
    """ Convenience method for setting the split level for a tree in a given file. """
 
    return setPoolAttribute( fileName  = fileName,
                             contName  = f"TTree={treeName}",
                             attrName  = "CONTAINER_SPLITLEVEL",
                             attrValue = splitLvl )
 

setFileCompAlg()

python.PoolAttributeHelper.setFileCompAlg	(		fileName = None,
			compAlg = None )

Convenience method for setting the compression algorithm for a given file. 

Definition at line 32 of file PoolAttributeHelper.py.

def setFileCompAlg( fileName = None, compAlg = None ):
    """ Convenience method for setting the compression algorithm for a given file. """
 
    return setPoolAttribute( fileName  = fileName, 
                             attrName  = "COMPRESSION_ALGORITHM",
                             attrValue = compAlg )
 

setFileCompLvl()

python.PoolAttributeHelper.setFileCompLvl	(		fileName = None,
			compLvl = None )

Convenience method for setting the compression level for a given file. 

Definition at line 39 of file PoolAttributeHelper.py.

def setFileCompLvl( fileName = None, compLvl = None ):
    """ Convenience method for setting the compression level for a given file. """
 
    return setPoolAttribute( fileName  = fileName, 
                             attrName  = "COMPRESSION_LEVEL",
                             attrValue = compLvl )
 

setMaxBufferSize()

python.PoolAttributeHelper.setMaxBufferSize	(		fileName = None,
			bufferSize = None )

Convenience method for setting the maximum basket buffer size 

Definition at line 46 of file PoolAttributeHelper.py.

def setMaxBufferSize( fileName = None, bufferSize = None ):
    """ Convenience method for setting the maximum basket buffer size """
 
    return setPoolAttribute( fileName = fileName,
                             attrName = "MAXIMUM_BUFFERSIZE",
                             attrValue = bufferSize )
 

setMinBufferEntries()

python.PoolAttributeHelper.setMinBufferEntries	(		fileName = None,
			nEntries = None )

Convenience method for setting the minimum basket buffer entries 

Definition at line 53 of file PoolAttributeHelper.py.

def setMinBufferEntries( fileName = None, nEntries = None ):
    """ Convenience method for setting the minimum basket buffer entries """
 
    return setPoolAttribute( fileName = fileName,
                             attrName = "MINIMUM_BUFFERENTRIES",
                             attrValue = nEntries )
 

setPoolAttribute()

python.PoolAttributeHelper.setPoolAttribute

(

**

kwargs

)

The low-level function that builds the requested Pool Attribure string. 

Definition at line 5 of file PoolAttributeHelper.py.

def setPoolAttribute( **kwargs ):
    """ The low-level function that builds the requested Pool Attribure string. """
 
    # Resolve the variables for convenience
    fileName  = kwargs.get('fileName')
    contName  = kwargs.get('contName')
    attrName  = kwargs.get('attrName')
    attrValue = kwargs.get('attrValue')
 
    # Now let's build the string
    result = ""
 
    # First set the domain attribute
    if not attrName or not attrValue:
        return result
    result += f"{attrName} = '{attrValue}';"
 
    # Then set database and container level attributes
    # These are optional: can set both, only one, or neither 
    if contName:
        result = f"ContainerName = '{contName}'; {result}"
    if fileName:
        result = f"DatabaseName = '{fileName}'; {result}"
 
    # Finally return the result
    return result
 

setTreeAutoFlush()

python.PoolAttributeHelper.setTreeAutoFlush	(		fileName = None,
			treeName = None,
			autoFlush = None )

Convenience method for setting the AutoFlush for a tree in a given file. 

Definition at line 60 of file PoolAttributeHelper.py.

def setTreeAutoFlush( fileName = None, treeName = None, autoFlush = None ):
    """ Convenience method for setting the AutoFlush for a tree in a given file. """
 
    return setPoolAttribute( fileName  = fileName,
                             contName  = f"TTree={treeName}",
                             attrName  = "TREE_AUTO_FLUSH",
                             attrValue = autoFlush )
 

Variable Documentation

attrName

python.PoolAttributeHelper.attrName

Definition at line 100 of file PoolAttributeHelper.py.

attrs

list python.PoolAttributeHelper.attrs = []

Definition at line 89 of file PoolAttributeHelper.py.

attrValue

python.PoolAttributeHelper.attrValue

Definition at line 100 of file PoolAttributeHelper.py.