Inheritance diagram for ProgressPython:

Public Member Functions
	__init__ (self, queue)

	initialize (self)

	event (self)

	terminate (self)

Public Attributes
	queue = queue
	The queue to handle.

int	event_number = 0
	The current event number.

int	total_number_of_events = 0
	The total number of events.

Detailed Description

A small module that prints every now and then the event number to the given connection.
It is used for status viewers. Do not call it by yourself.

Definition at line 85 of file python_modules.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
			queue )

 Init the module

Definition at line 92 of file python_modules.py.

    def __init__(self, queue):
        """ Init the module """
        super().__init__()
        
        self.queue = queue
        
        self.event_number = 0
        
        self.total_number_of_events = 0
        self.queue.send("init")
 

Member Function Documentation

◆ event()

event ( self )

 Send the event number to the connection

Definition at line 111 of file python_modules.py.

    def event(self):
        """ Send the event number to the connection """
        if self.total_number_of_events == 0:
            return
 
        current_percentage = 1.0 * self.event_number / self.total_number_of_events
 
        if 100 * current_percentage % 5 == 0:
            self.queue.send(current_percentage)
 
        self.event_number += 1
 

◆ initialize()

initialize ( self )

 Send start to the connection

Definition at line 103 of file python_modules.py.

    def initialize(self):
        """ Send start to the connection """
        self.queue.send("start")
 
        # Receive the total number of events
 
        self.total_number_of_events = Belle2.Environment.Instance().getNumberOfEvents()
 

◆ terminate()

terminate ( self )

 Send stop to the connection

Definition at line 123 of file python_modules.py.

    def terminate(self):
        """ Send stop to the connection """
        self.queue.send(1)
        self.queue.send("end")

Member Data Documentation

◆ event_number

int event_number = 0

The current event number.

Definition at line 98 of file python_modules.py.

◆ queue

queue = queue

The queue to handle.

Definition at line 96 of file python_modules.py.

◆ total_number_of_events

int total_number_of_events = 0

The total number of events.

Definition at line 100 of file python_modules.py.

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

framework/scripts/hep_ipython_tools/ipython_handler_basf2/python_modules.py

Public Member Functions

Public Attributes