Package schrodinger :: Package tasks :: Module tasks :: Class ThreadFunctionTask
[hide private]
[frames] | no frames]

Class ThreadFunctionTask

                                    object --+            
                                             |            
ui.qt.appframework2.validation.ValidationMixin --+        
                                                 |        
                object --+                       |        
                         |                       |        
         sip.simplewrapper --+                   |        
                             |                   |        
                   sip.wrapper --+               |        
                                 |               |        
              PyQt5.QtCore.QObject --+           |        
                                     |           |        
                      parameters.Param --+       |        
                                         |       |        
                  parameters.CompoundParam --+   |        
                                             |   |        
                         parameters.ParamModel --+        
                                                 |        
                                      AbstractTask --+    
                                                     |    
                                      BaseFunctionTask --+
                                                         |
                                                        ThreadFunctionTask

Nested Classes [hide private]

Inherited from parameters.CompoundParam: __metaclass__

Inherited from parameters.Param: NO_VALUE

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
 
guardedRunMain(self)
bool
_start(self)
Override this method in subclasses to implement the actual task starting logic.
 
wait(self)
Process events until this task is no longer running, then return.
 
onThreadFinished(self)
 
isRunning(self)

Inherited from BaseFunctionTask: runMain

Inherited from AbstractTask: __repr__, __str__, base_nameChanged, getName, nameChanged, postStart, preProcess, preValidate, reportValidation, setStatus, start, status, statusChanged, status_paramChanged

Inherited from ui.qt.appframework2.validation.ValidationMixin: runValidation

Inherited from ui.qt.appframework2.validation.ValidationMixin (private): _validate, _validateChildren

Inherited from parameters.CompoundParam: __eq__, __ne__, fromJson, isDefault, setValue, toDict, toJson

Inherited from parameters.CompoundParam (private): _defaultValue

Inherited from parameters.Param: __get__, __set__, ownerChain, valueChanged

Inherited from PyQt5.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChildren, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, objectNameChanged, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr

Inherited from sip.simplewrapper: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from AbstractTask: base_name, name, status_param

Inherited from parameters.Param: DataClass, is_abstract

Inherited from PyQt5.QtCore.QObject: staticMetaObject

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

_start(self)

 

Override this method in subclasses to implement the actual task starting logic. This is called after all preprocessing and validation have passed.

Returns: bool
whether the task was succesfully started
Overrides: AbstractTask._start
(inherited documentation)

wait(self)

 

Process events until this task is no longer running, then return. If the task is not running when this is called, it wil return immediately.

isRunning(self)

 
Overrides: AbstractTask.isRunning