Inheritance diagram for WrapperModule:

[legend]

Collaboration diagram for WrapperModule:

Public Member Functions
def	__init__ (self, module)

def	wrapper_name (self)

def	param (self)

def	available_params (self)

def	compose_wrapped_module_name (self, module)

def	get_name (self)

def	initialize (self)

def	beginRun (self)

def	event (self)

def	endRun (self)

def	terminate (self)

Public Attributes
	module
	The wrapped module.

Detailed Description

Wrapping module base class that wraps a single module to slightly change its behaviour.

The base implementation does nothing, but forward the relevant methods to the wrapped module.

Note:
  Implements the decorator/wrapper pattern.

Attributes:
  module (basf2.Module): The wrapped module instance.

Definition at line 34 of file metamodules.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		module
	)

Create a new wrapper module around the given module. This base implementation does not change anything,
   so there is no reason to use this base implementation alone.

Reimplemented in IfMCParticlesPresentModule.

Definition at line 47 of file metamodules.py.

Member Function Documentation

◆ available_params()

def available_params ( self )

Forwards the avaiilable parameters

Definition at line 79 of file metamodules.py.

◆ beginRun()

def beginRun ( self )

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
	)

Compose a name that indicates the wrapped module.

Definition at line 83 of file metamodules.py.

◆ endRun()

def endRun ( self )

End run method of the module

Definition at line 104 of file metamodules.py.

◆ event()

def event ( self )

Event method of the module

Reimplemented in IfModule, and PyProfilingModule.

Definition at line 100 of file metamodules.py.

◆ get_name()

def get_name ( self )

Forwards the name().

Definition at line 88 of file metamodules.py.

◆ initialize()

def initialize ( self )

Initialize method of the module

Reimplemented in IfStoreArrayPresentModule, and PyProfilingModule.

Definition at line 92 of file metamodules.py.

◆ param()

def param ( self )

Forwards the parameters

Definition at line 74 of file metamodules.py.

◆ terminate()

def terminate ( self )

Terminate method of the module

Reimplemented in PyProfilingModule.

Definition at line 108 of file metamodules.py.

◆ wrapper_name()

def wrapper_name ( self )

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

Public Member Functions

Public Attributes