WrapperModule Class Reference

Inheritance diagram for WrapperModule:

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

Public Attributes
	module = 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 33 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

__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.

Definition at line 46 of file metamodules.py.

    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."""
        super().__init__()
        name = self.compose_wrapped_module_name(module)
 
        
        self.module = module
 
        # Forward the logging parameters
        self.set_debug_level(self.module.logging.debug_level)
        self.set_abort_level(self.module.logging.abort_level)
 
        if self.module.logging.log_level != basf2.LogLevel.default:
            self.set_log_level(self.module.logging.log_level)
            self.set_log_info(self.module.logging.log_level,
                              self.module.logging.get_info(self.module.logging.log_level))
 
        # Forward the name of this module to the C++ world
        self.set_name(name)
 

Member Function Documentation

available_params()

available_params

(

self

)

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

)

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 )

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

endRun()

endRun

(

self

)

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

Reimplemented in IfModule, and PyProfilingModule.

Definition at line 98 of file metamodules.py.

    def event(self):
        """Event method of the module"""
        self.module.event()
 

get_name()

get_name

(

self

)

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

)

Forwards the parameters

Definition at line 73 of file metamodules.py.

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

terminate()

terminate

(

self

)

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

)

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

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