MinModule Class Reference

Inheritance diagram for MinModule:

Collaboration diagram for MinModule:

Public Member Functions
def	__init__ (self)
def	initialize (self)
def	beginRun (self)
def	event (self)
def	endRun (self)
def	terminate (self)

Detailed Description

A minimal example of a basf2 module in python.

Definition at line 6 of file 083_module.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor

Definition at line 9 of file 083_module.py.

    def __init__(self):
        """Constructor"""
        # call constructor of base class, required if you implement __init__
        # yourself!
        super().__init__()
        # and do whatever else is necessary like declaring member variables
 

Member Function Documentation

beginRun()

def beginRun

(

self

)

Called every time a run changes before the actual events in that run
are processed

Definition at line 20 of file 083_module.py.

endRun()

def endRun

(

self

)

Called every time a run changes after the actual events in that run
were processed

Definition at line 30 of file 083_module.py.

event()

def event

(

self

)

Called once for each event

Definition at line 26 of file 083_module.py.

initialize()

def initialize

(

self

)

Called once in the beginning just before starting processing

Definition at line 16 of file 083_module.py.

terminate()

def terminate

(

self

)

Called once after all the processing is complete

Definition at line 36 of file 083_module.py.

---

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

• online_book/basf2/steering_files/083_module.py