IfModule Class Reference

Inheritance diagram for IfModule:

Collaboration diagram for IfModule:

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

Public Attributes
	condition = condition
	Condition function called at each event to determine if wrapped module should be executed.
	module = module
	The wrapped module.

Detailed Description

Wrapper module to conditionally execute module and continue with the normal path afterwards.

There are two ways to specify the condition.
One way is to override the condition(self) method in a subclass.
The second way is to give a function as the second argument to the module constructor,
which is called each event.

Attributes:
  module (basf2.Module): The module executed, if the condition is met.

  condition (function() -> bool, optional): Function executed at each event to determine,
    if the given module shall be executed.
    If None call the condition method instead, which can be overridden by subclasses.

Definition at line 165 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			module,
			condition = None )

Initialisation method taking the module instance to be wrapped.

Args:
  module (basf2.Module): The module executed, if the condition is met.
  condition  (function() -> bool, optional): Function executed at each event to determine,
    if the given module shall be executed.
    If None call the condition method instead, which can be overridden by subclasses.

Definition at line 183 of file metamodules.py.

    def __init__(self, module, condition=None):
        """Initialisation method taking the module instance to be wrapped.
 
        Args:
          module (basf2.Module): The module executed, if the condition is met.
          condition  (function() -> bool, optional): Function executed at each event to determine,
            if the given module shall be executed.
            If None call the condition method instead, which can be overridden by subclasses.
        """
 
        super().__init__(module)
        if condition is not None:
            
            self.condition = condition
 

Member Function Documentation

available_params()

available_params ( self )

inherited

Forwards the available parameters

Definition at line 78 of file metamodules.py.

    def available_params(self):
        """Forwards the available parameters"""
        return self.module.available_params
 

beginRun()

beginRun ( self )

inherited

Begin run method of the module

Definition at line 94 of file metamodules.py.

    def beginRun(self):
        """Begin run method of the module"""
        self.module.beginRun()
 

compose_wrapped_module_name()

compose_wrapped_module_name ( self, module )

inherited

Compose a name that indicates the wrapped module.

Definition at line 82 of file metamodules.py.

    def compose_wrapped_module_name(self, module):
        """Compose a name that indicates the wrapped module."""
        return f"{self.wrapper_name}({module.name()})"
 

condition()

condition

(

self

)

Condition method called if not given a condition function during construction.

Can be overridden by a concrete subclass to specify
under which condition the wrapped module should be executed.
It can also be shadowed by a condition function given to the constructor of this module.

Returns:
  bool: The indication if the wrapped module should be executed.
    Always True in the base implementation

Reimplemented in IfStoreArrayNotPresentModule, and IfStoreArrayPresentModule.

Definition at line 199 of file metamodules.py.

    def condition(self):
        """Condition method called if not given a condition function during construction.
 
        Can be overridden by a concrete subclass to specify
        under which condition the wrapped module should be executed.
        It can also be shadowed by a condition function given to the constructor of this module.
 
        Returns:
          bool: The indication if the wrapped module should be executed.
            Always True in the base implementation
        """
        return True
 

endRun()

endRun ( self )

inherited

End run method of the module

Definition at line 102 of file metamodules.py.

    def endRun(self):
        """End run method of the module"""
        self.module.endRun()
 

event()

event

(

self

)

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 212 of file metamodules.py.

    def event(self):
        """Event method of the module
 
        Evaluates the condition and sets the return value of this module
        to trigger the execution of the wrapped module.
        """
 
        if self.condition():
            super().event()
 
 

get_name()

get_name ( self )

inherited

Forwards the name().

Definition at line 86 of file metamodules.py.

    def get_name(self):
        """Forwards the name()."""
        return self.name()
 

initialize()

initialize ( self )

inherited

Initialize method of the module

Reimplemented in IfStoreArrayPresentModule, and PyProfilingModule.

Definition at line 90 of file metamodules.py.

    def initialize(self):
        """Initialize method of the module"""
        self.module.initialize()
 

param()

param ( self )

inherited

Forwards the parameters

Definition at line 73 of file metamodules.py.

    def param(self):
        """Forwards the parameters"""
        return self.module.param
 

terminate()

terminate ( self )

inherited

Terminate method of the module

Reimplemented in PyProfilingModule.

Definition at line 106 of file metamodules.py.

    def terminate(self):
        """Terminate method of the module"""
        self.module.terminate()
 
 

wrapper_name()

wrapper_name ( self )

inherited

Name of the wrapper class.

Definition at line 68 of file metamodules.py.

    def wrapper_name(self):
        """Name of the wrapper class."""
        return self.__class__.__name__
 

Member Data Documentation

condition

condition = condition

Condition function called at each event to determine if wrapped module should be executed.

Reimplemented in IfStoreArrayNotPresentModule, and IfStoreArrayPresentModule.

Definition at line 197 of file metamodules.py.

module

module = module

inherited

The wrapped module.

Definition at line 53 of file metamodules.py.

---

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

• tracking/scripts/tracking/metamodules.py