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

argdict	Argument dictionary for this executor
dataDictionary	Mapping from input data names to argFile instances
firstExecutor	Boolean set to True if we are the first executor

Definition at line 62 of file trfExe.py.

    def __init__(self, argdict={}, dataDictionary={}, firstExecutor=False):
        self._argdict = argdict
        self._dataDictionary = dataDictionary
        self._firstExecutor = firstExecutor
        self._executorStep = -1
        self._totalExecutorSteps = 0
 

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.

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

addToDataDictionary()

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

Add a new object to the dataDictionary.

Definition at line 121 of file trfExe.py.

    def addToDataDictionary(self, key, value):
        self._dataDictionary[key] = value
 
 

argdict() [1/2]

def python.trfExe.executorConfig.argdict

(

self

)

Definition at line 70 of file trfExe.py.

    def argdict(self):
        return self._argdict
    

argdict() [2/2]

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

Definition at line 74 of file trfExe.py.

    def argdict(self, value):
        self._argdict = value
 

dataDictionary() [1/2]

def python.trfExe.executorConfig.dataDictionary

(

self

)

Definition at line 78 of file trfExe.py.

    def dataDictionary(self):
        return self._dataDictionary
    

dataDictionary() [2/2]

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

Definition at line 82 of file trfExe.py.

    def dataDictionary(self, value):
        self._dataDictionary = value
 

executorStep() [1/2]

def python.trfExe.executorConfig.executorStep

(

self

)

Definition at line 94 of file trfExe.py.

    def executorStep(self):
        return self._executorStep
 

executorStep() [2/2]

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

Definition at line 98 of file trfExe.py.

    def executorStep(self, value):
        self._executorStep = value
 

firstExecutor() [1/2]

def python.trfExe.executorConfig.firstExecutor

(

self

)

Definition at line 86 of file trfExe.py.

    def firstExecutor(self):
        return self._firstExecutor
    

firstExecutor() [2/2]

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

Definition at line 90 of file trfExe.py.

    def firstExecutor(self, value):
        self._firstExecutor = value
 

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.

    def setFromTransform(self, trf):
        self._argdict = trf.argdict
        self._dataDictionary = trf.dataDictionary
        

totalExecutorSteps() [1/2]

def python.trfExe.executorConfig.totalExecutorSteps

(

self

)

Definition at line 102 of file trfExe.py.

    def totalExecutorSteps(self):
        return self._totalExecutorSteps
 

totalExecutorSteps() [2/2]

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

Definition at line 106 of file trfExe.py.

    def totalExecutorSteps(self, value):
        self._totalExecutorSteps = value
 

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:

• trfExe.py