IfModule Class Reference

Inheritance diagram for IfModule:

Public Member Functions
def	__init__ (self, module, condition=None)
def	condition (self)
def	event (self)

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

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 condtion(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__()

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.

Reimplemented from WrapperModule.

Reimplemented in IfMCParticlesPresentModule, and IfStoreArrayPresentModule.

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

condition()

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

Reimplemented in IfStoreArrayPresentModule, and IfStoreArrayNotPresentModule.

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
 

event()

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.

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()
 
 

Member Data Documentation

condition

condition

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

Reimplemented in IfStoreArrayPresentModule, and IfStoreArrayNotPresentModule.

Definition at line 197 of file metamodules.py.

---

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

• tracking/scripts/tracking/metamodules.py