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 57 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 63 of file trfExe.py.

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

Member Function Documentation

◆ addToArgdict()

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

Add a new object to the argdict.

Definition at line 118 of file trfExe.py.

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

◆ addToDataDictionary()

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

Add a new object to the dataDictionary.

Definition at line 122 of file trfExe.py.

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

◆ argdict() [1/2]

def python.trfExe.executorConfig.argdict (   self)

Definition at line 71 of file trfExe.py.

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

◆ argdict() [2/2]

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

Definition at line 75 of file trfExe.py.

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

◆ dataDictionary() [1/2]

def python.trfExe.executorConfig.dataDictionary (   self)

Definition at line 79 of file trfExe.py.

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

◆ dataDictionary() [2/2]

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

Definition at line 83 of file trfExe.py.

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

◆ executorStep() [1/2]

def python.trfExe.executorConfig.executorStep (   self)

Definition at line 95 of file trfExe.py.

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

◆ executorStep() [2/2]

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

Definition at line 99 of file trfExe.py.

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

◆ firstExecutor() [1/2]

def python.trfExe.executorConfig.firstExecutor (   self)

Definition at line 87 of file trfExe.py.

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

◆ firstExecutor() [2/2]

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

Definition at line 91 of file trfExe.py.

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

◆ 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 113 of file trfExe.py.

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

◆ totalExecutorSteps() [1/2]

def python.trfExe.executorConfig.totalExecutorSteps (   self)

Definition at line 103 of file trfExe.py.

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

◆ totalExecutorSteps() [2/2]

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

Definition at line 107 of file trfExe.py.

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

Member Data Documentation

◆ _argdict

python.trfExe.executorConfig._argdict
private

Definition at line 64 of file trfExe.py.

◆ _dataDictionary

python.trfExe.executorConfig._dataDictionary
private

Definition at line 65 of file trfExe.py.

◆ _executorStep

python.trfExe.executorConfig._executorStep
private

Definition at line 67 of file trfExe.py.

◆ _firstExecutor

python.trfExe.executorConfig._firstExecutor
private

Definition at line 66 of file trfExe.py.

◆ _totalExecutorSteps

python.trfExe.executorConfig._totalExecutorSteps
private

Definition at line 68 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