Package node_manager_fkie :: Module progress_queue :: Class ProgressQueue
[frames] | no frames]

Class ProgressQueue

source code

       object --+            
                |            
sip.simplewrapper --+        
                    |        
          sip.wrapper --+    
                        |    
     PyQt4.QtCore.QObject --+
                            |
                           ProgressQueue

The queue provides a threaded execution of given tasks.

Instance Methods
 
__init__(self, progress_frame, progress_bar, progress_cancel_button)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
stop(self)
Deletes all queued tasks and wait 3 seconds for the end of current running thread.
source code
 
add2queue(self, ident, descr, target=None, args=())
Adds new task to the queue.
source code
 
start(self)
Starts the execution of tasks in the queue.
source code
 
count(self)
:return: the count of tasks in the queue :rtype: int
source code
 
has_id(self, ident)
Searches the current and planed threads for given id and returns `True` if one is found.
source code

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

Inherited from sip.simplewrapper: __new__

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

Class Variables

Inherited from PyQt4.QtCore.QObject: staticMetaObject

Properties

Inherited from object: __class__

Method Details

__init__(self, progress_frame, progress_bar, progress_cancel_button)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

add2queue(self, ident, descr, target=None, args=())

source code 

Adds new task to the queue. After the task was added you need call start(). :param ident: the unique identification string :type ident: str :param descr: the description of the task :type descr: str :param target: is the callable object to be invoked in a new thread. Defaults to None, meaning nothing is called. :param args: is the argument tuple for the target invocation. Defaults to ()