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

Public Member Functions

def __init__ (self, argdict={}, dataDictionary={}, firstExecutor=False)
 Configuration for an executor. More...
 
def argdict (self)
 
def argdict (self, value)
 
def dataDictionary (self)
 
def dataDictionary (self, value)
 
def firstExecutor (self)
 
def firstExecutor (self, value)
 
def executorStep (self)
 
def executorStep (self, value)
 
def totalExecutorSteps (self)
 
def totalExecutorSteps (self, value)
 
def setFromTransform (self, trf)
 Set configuration properties from the parent transform. More...
 
def addToArgdict (self, key, value)
 Add a new object to the argdict. More...
 
def addToDataDictionary (self, key, value)
 Add a new object to the dataDictionary. More...
 

Private Attributes

 _argdict
 
 _dataDictionary
 
 _firstExecutor
 
 _executorStep
 
 _totalExecutorSteps
 

Detailed Description

Note
This class contains the configuration information necessary to run an executor. In most cases this is simply a collection of references to the parent transform, however, abstraction is done via an instance of this class so that 'lightweight' executors can be run for auxiliary purposes (e.g., file merging after AthenaMP was used, where the merging is outside of the main workflow, but invoked in the main executor's "postExecute" method).

Definition at line 56 of file trfExe.py.

Constructor & Destructor Documentation

◆ __init__()

def python.trfExe.executorConfig.__init__ (   self,
  argdict = {},
  dataDictionary = {},
  firstExecutor = False 
)

Configuration for an executor.

Parameters
argdictArgument dictionary for this executor
dataDictionaryMapping from input data names to argFile instances
firstExecutorBoolean set to True if we are the first executor

Definition at line 62 of file trfExe.py.

62  def __init__(self, argdict={}, dataDictionary={}, firstExecutor=False):
63  self._argdict = argdict
64  self._dataDictionary = dataDictionary
65  self._firstExecutor = firstExecutor
66  self._executorStep = -1
67  self._totalExecutorSteps = 0
68 

Member Function Documentation

◆ addToArgdict()

def python.trfExe.executorConfig.addToArgdict (   self,
  key,
  value 
)

Add a new object to the argdict.

Definition at line 117 of file trfExe.py.

117  def addToArgdict(self, key, value):
118  self._argdict[key] = value
119 

◆ addToDataDictionary()

def python.trfExe.executorConfig.addToDataDictionary (   self,
  key,
  value 
)

Add a new object to the dataDictionary.

Definition at line 121 of file trfExe.py.

121  def addToDataDictionary(self, key, value):
122  self._dataDictionary[key] = value
123 
124 

◆ argdict() [1/2]

def python.trfExe.executorConfig.argdict (   self)

Definition at line 70 of file trfExe.py.

70  def argdict(self):
71  return self._argdict
72 

◆ argdict() [2/2]

def python.trfExe.executorConfig.argdict (   self,
  value 
)

Definition at line 74 of file trfExe.py.

74  def argdict(self, value):
75  self._argdict = value
76 

◆ dataDictionary() [1/2]

def python.trfExe.executorConfig.dataDictionary (   self)

Definition at line 78 of file trfExe.py.

78  def dataDictionary(self):
79  return self._dataDictionary
80 

◆ dataDictionary() [2/2]

def python.trfExe.executorConfig.dataDictionary (   self,
  value 
)

Definition at line 82 of file trfExe.py.

82  def dataDictionary(self, value):
83  self._dataDictionary = value
84 

◆ executorStep() [1/2]

def python.trfExe.executorConfig.executorStep (   self)

Definition at line 94 of file trfExe.py.

94  def executorStep(self):
95  return self._executorStep
96 

◆ executorStep() [2/2]

def python.trfExe.executorConfig.executorStep (   self,
  value 
)

Definition at line 98 of file trfExe.py.

98  def executorStep(self, value):
99  self._executorStep = value
100 

◆ firstExecutor() [1/2]

def python.trfExe.executorConfig.firstExecutor (   self)

Definition at line 86 of file trfExe.py.

86  def firstExecutor(self):
87  return self._firstExecutor
88 

◆ firstExecutor() [2/2]

def python.trfExe.executorConfig.firstExecutor (   self,
  value 
)

Definition at line 90 of file trfExe.py.

90  def firstExecutor(self, value):
91  self._firstExecutor = value
92 

◆ setFromTransform()

def python.trfExe.executorConfig.setFromTransform (   self,
  trf 
)

Set configuration properties from the parent transform.

Note
It's not possible to set firstExecutor here as the transform holds the name of the first executor, which we don't know... (should we?)

Definition at line 112 of file trfExe.py.

112  def setFromTransform(self, trf):
113  self._argdict = trf.argdict
114  self._dataDictionary = trf.dataDictionary
115 

◆ totalExecutorSteps() [1/2]

def python.trfExe.executorConfig.totalExecutorSteps (   self)

Definition at line 102 of file trfExe.py.

102  def totalExecutorSteps(self):
103  return self._totalExecutorSteps
104 

◆ totalExecutorSteps() [2/2]

def python.trfExe.executorConfig.totalExecutorSteps (   self,
  value 
)

Definition at line 106 of file trfExe.py.

106  def totalExecutorSteps(self, value):
107  self._totalExecutorSteps = value
108 

Member Data Documentation

◆ _argdict

python.trfExe.executorConfig._argdict
private

Definition at line 63 of file trfExe.py.

◆ _dataDictionary

python.trfExe.executorConfig._dataDictionary
private

Definition at line 64 of file trfExe.py.

◆ _executorStep

python.trfExe.executorConfig._executorStep
private

Definition at line 66 of file trfExe.py.

◆ _firstExecutor

python.trfExe.executorConfig._firstExecutor
private

Definition at line 65 of file trfExe.py.

◆ _totalExecutorSteps

python.trfExe.executorConfig._totalExecutorSteps
private

Definition at line 67 of file trfExe.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
rerun_display.argdict
dictionary argdict
Definition: rerun_display.py:36