local Class Reference

Process opals jobs on the local machine in current process (no parallelization) More...

Inheritance diagram for local:

Public Member Functions
def	__init__ (self)
def	__del__ (self)
def	__str__ (self)
def	submit (self, module=None, finishedText=None, userData=None)
def	submit_and_join (self, module=None, finishedText=None, userData=None, raiseExceptions=True)
def	join (self, raiseExceptions=True)
def	__len__ (self)
	Enables length query of the local processor object :return: length of the result list. More...
def	__getitem__ (self, idx)
	Enables index queries of the local processor object :param: index of the desired module :return: the module. 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 or None. More...
def	clear (self, logger=None)
	Clears the processor, i.e. More...
def	close (self)
	Serves as a placeholder function to have the same structure as the multiprocess class. More...
Public Member Functions inherited from processorInterface
def	submit (self)
def	submit_and_join (self)
def	join (self)
def	clear (self)

Public Attributes
	results
	logger
	not_joined_yet

Detailed Description

Process opals jobs on the local machine in current process (no parallelization)

Member Function Documentation

__getitem__()

def __getitem__	(		self,
			idx
	)

Enables index queries of the local processor object :param: index of the desired module :return: the module.

References local.results.

__len__()

def __len__

(

self

)

Enables length query of the local processor object :return: length of the result list.

References local.results.

clear()

def clear	(		self,
			logger = None
	)

Clears the processor, i.e.

the result list :return: None

References local.logger, and local.results.

close()

def close

(

self

)

Serves as a placeholder function to have the same structure as the multiprocess class.

:return: None

Reimplemented from processorInterface.

get_error()

def get_error	(		self,
			idx
	)

Returns an exception that occured during a module run :param: index of a module :return: exception or None.

References local.results.

get_result()

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.

References local.results.

get_userdata()

def get_userdata	(		self,
			idx
	)

Returns the userdata back to the user.

:param idx: index of the module :return: userdata

References local.results.

was_successful()

def was_successful	(		self,
			idx
	)

Gives information about whether or not a module run was successful :param idx: index of the module :return: Boolean.

References local.results.