Inheritance diagram for IfStoreArrayPresentModule:

Public Member Functions
	__init__ (self, module, storearray_name, storearray_durability=0)

	initialize (self)

	condition (self)

	event (self)

	wrapper_name (self)

	param (self)

	available_params (self)

	compose_wrapped_module_name (self, module)

	get_name (self)

	beginRun (self)

	endRun (self)

	terminate (self)

Public Attributes
	storearray_name = storearray_name
	Name of the StoreArray to be checked (str).

	storearray_durability = storearray_durability
	Durability of the StoreArray to be checked (int).

	storearray_is_present = None
	Flag that the StoreArray is present (bool).

	module = 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 234 of file metamodules.py.

Constructor & Destructor Documentation

◆ init()

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

                 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.
        """
 
        super().__init__(module)
 
        self.storearray_name = storearray_name
 
        self.storearray_durability = storearray_durability
 
        self.storearray_is_present = None

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 )

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

    def condition(self):
        """Returns true if the StoreArray is present.
 
        Checks presence of the StoreArray once and remembers the result for all following events.
        """
        if self.storearray_is_present is None:
            self.storearray_is_present = is_storearray_present(self.storearray_name,
                                                               self.storearray_durability)
        return self.storearray_is_present
 
 

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

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

Initialize the contained module (only if the condition is true).

Reimplemented from WrapperModule.

Definition at line 267 of file metamodules.py.

    def initialize(self):
        """Initialize the contained module (only if the condition is true)."""
        if self.condition():
            super().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

◆ module

module = module

inherited

The wrapped module.

Definition at line 53 of file metamodules.py.

◆ storearray_durability

storearray_durability = storearray_durability

Durability of the StoreArray to be checked (int).

Definition at line 262 of file metamodules.py.

◆ storearray_is_present

storearray_is_present = None

Flag that the StoreArray is present (bool).

Definition at line 265 of file metamodules.py.

◆ storearray_name

storearray_name = storearray_name

Name of the StoreArray to be checked (str).

Definition at line 259 of file metamodules.py.

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

tracking/scripts/tracking/metamodules.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ available_params()

◆ beginRun()

◆ compose_wrapped_module_name()

◆ condition()

◆ endRun()

◆ event()

◆ get_name()

◆ initialize()

◆ param()

◆ terminate()

◆ wrapper_name()

Member Data Documentation

◆ module

◆ storearray_durability

◆ storearray_is_present

◆ storearray_name

◆ init()