PathModule Class Reference

Inheritance diagram for PathModule:

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

Protected Attributes
	_path = 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 308 of file metamodules.py.

Constructor & Destructor Documentation

__init__()

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

    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.
        """
 
        super().__init__()
 
        if path is None:
            path = basf2.create_path()
 
        
        self._path = path
 
        if modules:
            for module in modules:
                path.add_module(module)
 
        self.if_true(path, basf2.AfterConditionPath.CONTINUE)
 
        # Pass a telling name to the C++ world
        if modules is None:
            itemCount = 0
        else:
            itemCount = len(modules)
        self.set_name(f"{self.__class__.__name__} ({itemCount} modules):")
 

Member Function Documentation

event()

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

    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.
        """
 
        self.return_value(True)

Member Data Documentation

_path

_path = path

protected

The contained path.

Definition at line 340 of file metamodules.py.

---

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

• tracking/scripts/tracking/metamodules.py