ATLAS Offline Software
Public Member Functions | Public Attributes | Private Attributes | List of all members
python.Block.Block Class Reference
Collaboration diagram for python.Block.Block:

Public Member Functions

def __init__ (self, name, lod, func, kw)
 
def defineHook (self, hook)
 

Public Attributes

 name
 
 lod
 
 func
 
 kw
 

Private Attributes

 _hooks
 

Detailed Description

Hold information about one D3PD block.

Attributes:
  name:   Name of this block.
  lod:    Level of detail.  See below.
  func:   Function to create the block Configurable.
  kw: Arguments to pass to the creation function.

The creation function will be called like this:

   b.func (name, **b.kw)

where name is the name for the tool.

However, if b.func is a class deriving from D3PDObject, then the creation
function will instead be called like this:

   b.func (level, name, parent_prefix, **b.kw)

LOD is used to control whether this block should be included.

In the simple case, this is an integer, and the block is included
if the block's level of detail is less than or equal to the
requested level of detail (unless the block was explicitly
included or excluded).

In the general case, LOD may be a function.  This is called with
two arguments, the requested level of detail and the block filler
arguments.  The requested level of detail will be an integer;
it will be 999 if the block was explicitly included, and -999
if the block was explicitly excluded.  The block filler arguments
is a dictionary of keyword arguments.  The LOD function should
return a boolean value saying whether or not the block should
be included.  It may also alter the dictionary of arguments
(this overrides all other argument settings).

Definition at line 11 of file Block.py.

Constructor & Destructor Documentation

◆ __init__()

def python.Block.Block.__init__ (   self,
  name,
  lod,
  func,
  kw 
)

Definition at line 48 of file Block.py.

48  def __init__ (self, name, lod, func, kw):
49  self.name = name
50  self.lod = lod
51  self.func = func
52  self.kw = kw
53  self._hooks = []
54  return
55 
56 

Member Function Documentation

◆ defineHook()

def python.Block.Block.defineHook (   self,
  hook 
)

Definition at line 58 of file Block.py.

58  def defineHook (self, hook):
59  self._hooks.append (hook)
60  return

Member Data Documentation

◆ _hooks

python.Block.Block._hooks
private

Definition at line 53 of file Block.py.

◆ func

python.Block.Block.func

Definition at line 51 of file Block.py.

◆ kw

python.Block.Block.kw

Definition at line 52 of file Block.py.

◆ lod

python.Block.Block.lod

Definition at line 50 of file Block.py.

◆ name

python.Block.Block.name

Definition at line 49 of file Block.py.


The documentation for this class was generated from the following file:
python.processes.powheg.ZZ.ZZ.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ZZ.py:18