Inheritance diagram for CalculationProcess:

Public Member Functions
	__init__ (self, result_queue, log_file_name, parameters)

	save_log (self)

	get_log (self)

	get (self, name)

	get_keys (self)

	start_process (self)

	prepare (self)

Public Attributes
bool	already_run = False
	True if already started/run.

	log_file_name = log_file_name
	Name of the log file to use.

	log_file_content = None
	Saved log file content after the run.

	result_queue = result_queue
	Result queue as a reference.

	parameters = parameters
	Parameters in process_parameter_space.

	progress_queue_local
	Create the queue for the progress python module.

	progress_queue_remote = Pipe()
	Create the queue for the progress python module.

bool	is_valid = True
	Set to false, if you do not want this process to show up in the process bar calculations.

Detailed Description

Abstract base class for doing the real processing of a calculation. Is used by the handler to
process the calculation you requested. Overload the start_process and prepare method to implement your calculation
and maybe also the __init__ method if you need to store more information on your process (like what to calculate).

See ipython_handler_basf2/calculation_process.py for an example implementation.

Definition at line 12 of file calculation_process.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		result_queue,
		log_file_name,
		parameters )

Create a new calculation process instance. The parameters here are the absolute standard. You probably have to redefine the
constructor in your own class.

Definition at line 21 of file calculation_process.py.

    def __init__(self, result_queue, log_file_name, parameters):
        """
        Create a new calculation process instance. The parameters here are the absolute standard. You probably have to redefine the
        constructor in your own class.
        """
        if result_queue is None:
            raise ValueError("Invalid result_queue")
 
        self.already_run = False
 
        self.log_file_name = log_file_name
 
        self.log_file_content = None
 
        self.result_queue = result_queue
 
        self.parameters = parameters
 
        self.progress_queue_local, self.progress_queue_remote = Pipe()
 
        self.is_valid = True
 
        # Prepare the environment.
        self.prepare()
 
        # Call the constructor of the base class.
        Process.__init__(self, target=self.start_process)

Member Function Documentation

◆ get()

get	(		self,
			name )

Return an item from the result queue. Only gives a result if the calculation has finished.
Use the Calculation for a better handling.

Definition at line 76 of file calculation_process.py.

    def get(self, name):
        """
        Return an item from the result queue. Only gives a result if the calculation has finished.
        Use the Calculation for a better handling.
        """
        if not self.is_alive():
            return self.result_queue.get(name)
 

◆ get_keys()

get_keys ( self )

Return the names of all item from the result queue. Only gives a result if the calculation has finished.
Use the Calculation for a better handling.

Definition at line 84 of file calculation_process.py.

    def get_keys(self):
        """
        Return the names of all item from the result queue. Only gives a result if the calculation has finished.
        Use the Calculation for a better handling.
        """
        if not self.is_alive():
            return self.result_queue.get_keys()
 

◆ get_log()

get_log ( self )

Return the log file content.
Use the methods of the Calculation for a better handling.

Definition at line 65 of file calculation_process.py.

    def get_log(self):
        """
        Return the log file content.
        Use the methods of the Calculation for a better handling.
        """
        if self.is_alive():
            return open(self.log_file_name).read()
        else:
            self.save_log()
            return self.log_file_content
 

◆ prepare()

prepare ( self )

Overload this function if you need to process some preparations
before doing the real calculation.

Reimplemented in Basf2CalculationProcess.

Definition at line 100 of file calculation_process.py.

    def prepare(self):
        """
        Overload this function if you need to process some preparations
        before doing the real calculation.
        """

◆ save_log()

save_log ( self )

Delete the log file and copy its content to the class.

Definition at line 56 of file calculation_process.py.

    def save_log(self):
        """
        Delete the log file and copy its content to the class.
        """
        if self.log_file_content is None:
            self.log_file_content = open(self.log_file_name).read()
            os.unlink(self.log_file_name)
            self.log_file_name = None
 

◆ start_process()

start_process ( self )

The function given to the process to start the calculation.
Do not call by yourself.
Resets the logging system, logs onto console and a file and sets the queues
(the result queue and the process queue) correctly.

Reimplemented in Basf2CalculationProcess.

Definition at line 92 of file calculation_process.py.

    def start_process(self):
        """
        The function given to the process to start the calculation.
        Do not call by yourself.
        Resets the logging system, logs onto console and a file and sets the queues
        (the result queue and the process queue) correctly.
        """
 

Member Data Documentation

◆ already_run

bool already_run = False

True if already started/run.

Create a new calculation process instance. The parameters here are the absolute standard. You probably have to redefine the
constructor in your own class.

Definition at line 30 of file calculation_process.py.

◆ is_valid

bool is_valid = True

Set to false, if you do not want this process to show up in the process bar calculations.

Definition at line 48 of file calculation_process.py.

◆ log_file_content

log_file_content = None

Saved log file content after the run.

Delete the log file and copy its content to the class.

Definition at line 36 of file calculation_process.py.

◆ log_file_name

log_file_name = log_file_name

Name of the log file to use.

Delete the log file and copy its content to the class.

Return the log file content.
Use the methods of the Calculation for a better handling.

Definition at line 33 of file calculation_process.py.

◆ parameters

parameters = parameters

Parameters in process_parameter_space.

Definition at line 42 of file calculation_process.py.

◆ progress_queue_local

progress_queue_local

Create the queue for the progress python module.

Definition at line 45 of file calculation_process.py.

◆ progress_queue_remote

progress_queue_remote = Pipe()