multiprocess Class Reference

Process opals jobs using multiple processes. More...

Inheritance diagram for multiprocess:

Public Member Functions
def	__init__ (self, count)
	Instantiates a multiprocess-Object. More...
def	__del__ (self)
def	__str__ (self)
def	close (self)
	Closes the processor pool. More...
Public Member Functions inherited from distributedBase
def	__init__ (self)
	Instantiates the distributed base Object. More...
def	submit (self, module=None, finishedText=None, userData=None)
	Submits modules to the processor which are then run. More...
def	join (self, raiseExceptions=True)
	Waits for all incomplete runs to be finished. More...
def	submit_and_join (self, module=None, finishedText=None, userData=None, raiseExceptions=True)
	Module is submitted to a worker, then waits until all the processes are finished. More...
def	__len__ (self)
	Enables length query of the multiprocessor object :return: length of the result list. More...
def	__getitem__ (self, idx)
	Enables index queries of the multiprocessor object :param: index of the desired module :return: the module itself. More...
def	was_successful (self, idx)
	Gives information about whether or not a module run was successful :param idx: index of the module :return: Boolean. More...
def	get_result (self, idx)
	Returns the result of a module run :param idx: index of the module :return : either the result of the module or an exception that occured during that module run. More...
def	get_userdata (self, idx)
	Returns the userdata back to the user. More...
def	get_error (self, idx)
	Returns an exception that occured during a module run :param: index of a module :return: exception. More...
def	clear (self, logger=None)
	Clears the processor, i.e. More...
Public Member Functions inherited from processorInterface
def	submit (self)
def	submit_and_join (self)
def	join (self)
def	clear (self)

Public Attributes
	pool
	count
	not_joined_yet
Public Attributes inherited from distributedBase
	results
	logger
	not_joined_yet

Detailed Description

Process opals jobs using multiple processes.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			count
	)

Instantiates a multiprocess-Object.

:param count: an integer specifying the desired number of processes in the worker pool :return: None

References AttributeDescription.count, AttributeBandDescription.count, multiprocess.count, local.not_joined_yet, distributedBase.not_joined_yet, and multiprocess.pool.

Member Function Documentation

close()

def close

(

self

)

Closes the processor pool.

:return: None

Reimplemented from processorInterface.

References distributedBase.join(), and multiprocess.pool.