Conditional execution of the wrapped module based on the presence of Monte Carlo information.
Definition at line 295 of file metamodules.py.
◆ __init__()
__init__ |
( |
| self, |
|
|
| module ) |
Args:
module (basf2.Module): The module executed, if the condition is met.
Definition at line 300 of file metamodules.py.
300 def __init__(self, module):
301 """
302 Args:
303 module (basf2.Module): The module executed, if the condition is met.
304 """
305 super().__init__(module, "MCParticles")
306
307
◆ available_params()
Forwards the available parameters
Definition at line 78 of file metamodules.py.
78 def available_params(self):
79 """Forwards the available parameters"""
80 return self.module.available_params
81
◆ beginRun()
Begin run method of the module
Definition at line 94 of file metamodules.py.
94 def beginRun(self):
95 """Begin run method of the module"""
96 self.module.beginRun()
97
◆ 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.
82 def compose_wrapped_module_name(self, module):
83 """Compose a name that indicates the wrapped module."""
84 return f"{self.wrapper_name}({module.name()})"
85
◆ condition()
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.
272 def condition(self):
273 """Returns true if the StoreArray is present.
274
275 Checks presence of the StoreArray once and remembers the result for all following events.
276 """
277 if self.storearray_is_present is None:
278 self.storearray_is_present = is_storearray_present(self.storearray_name,
279 self.storearray_durability)
280 return self.storearray_is_present
281
282
◆ endRun()
End run method of the module
Definition at line 102 of file metamodules.py.
102 def endRun(self):
103 """End run method of the module"""
104 self.module.endRun()
105
◆ event()
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.
212 def event(self):
213 """Event method of the module
214
215 Evaluates the condition and sets the return value of this module
216 to trigger the execution of the wrapped module.
217 """
218
219 if self.condition():
220 super().event()
221
222
◆ get_name()
Forwards the name().
Definition at line 86 of file metamodules.py.
86 def get_name(self):
87 """Forwards the name()."""
88 return self.name()
89
◆ initialize()
Initialize the contained module (only if the condition is true).
Reimplemented from WrapperModule.
Definition at line 267 of file metamodules.py.
267 def initialize(self):
268 """Initialize the contained module (only if the condition is true)."""
269 if self.condition():
270 super().initialize()
271
◆ param()
Forwards the parameters
Definition at line 73 of file metamodules.py.
73 def param(self):
74 """Forwards the parameters"""
75 return self.module.param
76
◆ terminate()
Terminate method of the module
Reimplemented in PyProfilingModule.
Definition at line 106 of file metamodules.py.
106 def terminate(self):
107 """Terminate method of the module"""
108 self.module.terminate()
109
110
◆ wrapper_name()
Name of the wrapper class.
Definition at line 68 of file metamodules.py.
68 def wrapper_name(self):
69 """Name of the wrapper class."""
70 return self.__class__.__name__
71
◆ module
◆ storearray_durability
storearray_durability = storearray_durability |
|
inherited |
Durability of the StoreArray to be checked (int).
Definition at line 262 of file metamodules.py.
◆ storearray_is_present
storearray_is_present = None |
|
inherited |
Flag that the StoreArray is present (bool).
Definition at line 265 of file metamodules.py.
◆ storearray_name
storearray_name = storearray_name |
|
inherited |
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: