KERNEL_PY.kernel.threadhelper.Runner Class Reference

Inheritance diagram for KERNEL_PY.kernel.threadhelper.Runner:

Public Member Functions
def	__init__ (self, functionToRun=None, *argv)
def	setFunction (self, functionToRun)
def	setArguments (self, *argv)
def	getReturn (self)
def	setCallbackFunction (self, callbackFunction)
def	setObserver (self, observerToNotify)
def	run (self)
def	notifyObserver (self)
def	callback (self)
def	isEnded (self)
def	getException (self)
def	getId (self)
def	wait (self, timeout=None)
def	kill (self, message="Arr�t demand�")
def	clear (self)

Private Attributes
	_stopevent
	_exception
	_return
	_observer
	_callbackFunction
	_id
	_function
	_argv

Detailed Description

This class provides a tool to run and drive a function in a dedicated thread.

Constructor & Destructor Documentation

__init__()

def KERNEL_PY.kernel.threadhelper.Runner.__init__	(		self,
			functionToRun = None,
		*	argv
	)

Member Function Documentation

callback()

def KERNEL_PY.kernel.threadhelper.Runner.callback

(

self

)

References KERNEL_PY.kernel.threadhelper.Runner._callbackFunction.

Referenced by KERNEL_PY.kernel.threadhelper.Runner.run().

clear()

def KERNEL_PY.kernel.threadhelper.Runner.clear

(

self

)

References KERNEL_PY.kernel.threadhelper.Runner._exception, KERNEL_PY.kernel.threadhelper.Runner._return, and KERNEL_PY.kernel.threadhelper.Runner._stopevent.

Referenced by KERNEL_PY.kernel.threadhelper.Runner.setArguments(), and KERNEL_PY.kernel.threadhelper.Runner.setFunction().

getException()

def KERNEL_PY.kernel.threadhelper.Runner.getException

(

self

)

References KERNEL_PY.kernel.threadhelper.Runner._exception.

getId()

def KERNEL_PY.kernel.threadhelper.Runner.getId

(

self

)

References Engines_Component_i._id, Abstract_Engines_Container_i._id, DF_Document._id, HDFobject._id, KERNEL_PY.kernel.threadhelper.Runner._id, Engines_Parallel_Component_i._id, Engines_Parallel_Container_i._id, and Container_proxy_impl_final._id.

getReturn()

def KERNEL_PY.kernel.threadhelper.Runner.getReturn

(

self

)

Retourne le resultat de la fonction. En cas d'erreur, on
r�cup�rera l'exception lev�e au moyen de la m�thode
getException().

References KERNEL_PY.kernel.threadhelper.Runner._return.

isEnded()

def KERNEL_PY.kernel.threadhelper.Runner.isEnded

(

self

)

Retourne true si la fonction s'est termin�e naturellement
(correctement ou en erreur). Utile pour les client qui
pratique le pooling (interrogation r�p�t�e � intervalle
r�gulier.

References KERNEL_PY.kernel.threadhelper.Runner._stopevent.

kill()

def KERNEL_PY.kernel.threadhelper.Runner.kill	(		self,
			message = "Arr�t demand�"
	)

Cette m�thode doit �tre appeler pour interrombre le
thread. Cet appel d�clare le thread comme en erreur (exception
mise � disposition par la m�thode getException().

References KERNEL_PY.kernel.threadhelper.Runner._exception, and KERNEL_PY.kernel.threadhelper.Runner._stopevent.

notifyObserver()

def KERNEL_PY.kernel.threadhelper.Runner.notifyObserver

(

self

)

References KERNEL_PY.kernel.threadhelper.Runner._observer.

Referenced by KERNEL_PY.kernel.threadhelper.Runner.run().

run()

def KERNEL_PY.kernel.threadhelper.Runner.run

(

self

)

Ex�cution de la fonction. Impl�mentation de la m�thode run
d�clench�e par l'appel � Thread.start().

References Abstract_Engines_Container_i._argv, KERNEL_PY.kernel.threadhelper.Runner._argv, KERNEL_PY.kernel.threadhelper.Runner._exception, KERNEL_PY.kernel.threadhelper.Runner._function, KERNEL_PY.kernel.threadhelper.Runner._return, KERNEL_PY.kernel.threadhelper.Runner._stopevent, KERNEL_PY.kernel.threadhelper.Runner.callback(), SALOMEDSClient_Observer.notifyObserver(), and KERNEL_PY.kernel.threadhelper.Runner.notifyObserver().

setArguments()

def KERNEL_PY.kernel.threadhelper.Runner.setArguments	(		self,
		*	argv
	)

Positionne les arguments � passer � la fonction

References Engines::LogManager.clear(), SALOME_ContainerScriptExecPerfLog.clear(), SALOME_LogManager.clear(), KERNEL_PY.iparameters.IParameters.clear(), KERNEL_PY.kernel.threadhelper.Runner.clear(), SalomeSDSClt.Dict.clear(), and SALOMEWrappedStdType.Dict.clear().

setCallbackFunction()

def KERNEL_PY.kernel.threadhelper.Runner.setCallbackFunction	(		self,
			callbackFunction
	)

References KERNEL_PY.kernel.threadhelper.Runner._callbackFunction.

setFunction()

def KERNEL_PY.kernel.threadhelper.Runner.setFunction	(		self,
			functionToRun
	)

Positionne la fonction � ex�cuter. La fonction peut �tre la
m�thode d'un objet pass�e sous la forme 'monobjet.mamethode'.

References Engines::LogManager.clear(), SALOME_ContainerScriptExecPerfLog.clear(), SALOME_LogManager.clear(), KERNEL_PY.iparameters.IParameters.clear(), KERNEL_PY.kernel.threadhelper.Runner.clear(), SalomeSDSClt.Dict.clear(), and SALOMEWrappedStdType.Dict.clear().

setObserver()

def KERNEL_PY.kernel.threadhelper.Runner.setObserver	(		self,
			observerToNotify
	)

Permet de sp�cifier un observateur � notifier en fin
d'ex�cution. L'observateur est suppos� �tre un objet qui
impl�mente une m�thode processNotification()

References KERNEL_PY.kernel.threadhelper.Runner._observer, and uiexception.DevelException().

wait()

def KERNEL_PY.kernel.threadhelper.Runner.wait	(		self,
			timeout = None
	)

Met fin au thread apr�s timeout seconde s'il est encore en
ex�cution.
Si le compte-�-rebours est atteind sans que la fonction
functionToRun soit termin�e, alors le runner est laiss� dans
l'�tat 'not Ended', c'est-�-dire que isEnded retourne
false. On peut ainsi distinguer l'arr�t normal de l'arr�t �
l'issue du timeout.

Field Documentation

_argv

KERNEL_PY.kernel.threadhelper.Runner._argv

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.run().

_callbackFunction

KERNEL_PY.kernel.threadhelper.Runner._callbackFunction

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.callback(), and KERNEL_PY.kernel.threadhelper.Runner.setCallbackFunction().

_exception

KERNEL_PY.kernel.threadhelper.Runner._exception

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.clear(), KERNEL_PY.kernel.threadhelper.Runner.getException(), KERNEL_PY.kernel.threadhelper.Runner.kill(), and KERNEL_PY.kernel.threadhelper.Runner.run().

_function

KERNEL_PY.kernel.threadhelper.Runner._function

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.run().

_id

KERNEL_PY.kernel.threadhelper.Runner._id

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.getId().

_observer

KERNEL_PY.kernel.threadhelper.Runner._observer

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.notifyObserver(), and KERNEL_PY.kernel.threadhelper.Runner.setObserver().

_return

KERNEL_PY.kernel.threadhelper.Runner._return

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.clear(), KERNEL_PY.kernel.threadhelper.Runner.getReturn(), and KERNEL_PY.kernel.threadhelper.Runner.run().

_stopevent

KERNEL_PY.kernel.threadhelper.Runner._stopevent

private

Referenced by KERNEL_PY.kernel.threadhelper.Runner.clear(), KERNEL_PY.kernel.threadhelper.Runner.isEnded(), KERNEL_PY.kernel.threadhelper.Runner.kill(), and KERNEL_PY.kernel.threadhelper.Runner.run().