IfStoreArrayPresentModule Class Reference

Inheritance diagram for IfStoreArrayPresentModule:

Collaboration diagram for IfStoreArrayPresentModule:

Public Member Functions
def	__init__ (self, module, storearray_name, storearray_durability=0)
def	initialize (self)
def	condition (self)
def	event (self)
def	wrapper_name (self)
def	param (self)
def	available_params (self)
def	compose_wrapped_module_name (self, module)
def	get_name (self)
def	beginRun (self)
def	endRun (self)
def	terminate (self)

Public Attributes
	storearray_name
	Name of the StoreArray to be checked (str).
	storearray_durability
	Durability of the StoreArray to be checked (int).
	storearray_is_present
	Flag that the StoreArray is present (bool).
	condition
	Condition function called at each event to determine if wrapped module should be executed.
	module
	The wrapped module.

Detailed Description

Conditional execution of the wrapped module if a StoreArray is present.

Attributes:
  storearray_name (str): The name of the StoreArray which presence has to be checked.
  storearray_durability (int): The durability of the StoreArray
  storearray_is_present (bool): The flag whether the StoreArray is present.
    Set during initialisation.

Definition at line 236 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			module,
			storearray_name,
			storearray_durability = 0
	)

Args:
  module (basf2.Module): The module executed, if the condition is met.
  storearray_name (str): The name of the StoreArray which presence has to be checked.
  storearray_durability (int, optional): The durability of the StoreArray. Default 0.

Definition at line 247 of file metamodules.py.

Member Function Documentation

available_params()

def available_params (   self )

inherited

Forwards the avaiilable parameters

Definition at line 79 of file metamodules.py.

beginRun()

def beginRun (   self )

inherited

Begin run method of the module

Definition at line 96 of file metamodules.py.

compose_wrapped_module_name()

def compose_wrapped_module_name (   self,   module  )

inherited

Compose a name that indicates the wrapped module.

Definition at line 83 of file metamodules.py.

condition()

def condition

(

self

)

Returns true if the StoreArray is present.

Checks presence of the StoreArray once and remembers the result for all following events.

Reimplemented from IfModule.

Reimplemented in IfStoreArrayNotPresentModule.

Definition at line 274 of file metamodules.py.

endRun()

def endRun (   self )

inherited

End run method of the module

Definition at line 104 of file metamodules.py.

event()

def event (   self )

inherited

Event method of the module

Evaluates the condition and sets the return value of this module
to trigger the execution of the wrapped module.

Reimplemented from WrapperModule.

Definition at line 214 of file metamodules.py.

get_name()

def get_name (   self )

inherited

Forwards the name().

Definition at line 88 of file metamodules.py.

initialize()

def initialize

(

self

)

Initialize the contianed module (only of the condition is true).

Reimplemented from WrapperModule.

Definition at line 269 of file metamodules.py.

param()

def param (   self )

inherited

Forwards the parameters

Definition at line 74 of file metamodules.py.

terminate()

def terminate (   self )

inherited

Terminate method of the module

Reimplemented in PyProfilingModule.

Definition at line 108 of file metamodules.py.

wrapper_name()

def wrapper_name (   self )

inherited

Name of the wrapper class.

Definition at line 69 of file metamodules.py.

---

The documentation for this class was generated from the following file:

• tracking/scripts/tracking/metamodules.py