PathModule Class Reference

Inheritance diagram for PathModule:

Collaboration diagram for PathModule:

Public Member Functions
def	__init__ (self, path=None, modules=None)
def	event (self)

Private Attributes
	_path
	The contained path.

Detailed Description

Wrapper for a basf2 path into a module such that
it can be passed around and added to a basf2 path as a basf2 module.

The wrapper is implement in such a way that it unconditionally executes
the contained path by means of a positive return value.
The calling path is continued after the execution of the wrapped path.

Attributes:
  _path (basf2.Path): The wrapped execution path.

Definition at line 310 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			path = None,
			modules = None
	)

Initialises the module with a path to be wrapped.

May also give a list of modules that should be appended to the path.
If the path is omitted a new basf2.Path is constructed.

Args:
  path (basf2.Path): The execution path to be wrapped.
    If no path is given create a new one.

  modules (iterable of basf2.Module): Module to be added to the path.

Definition at line 323 of file metamodules.py.

Member Function Documentation

event()

def event

(

self

)

Event method of the module

Sets the return value of this module to true and triggers the execution of the wrapped path.

Definition at line 358 of file metamodules.py.

---

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

• tracking/scripts/tracking/metamodules.py