worker_thread.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Dorian Scholz
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 from python_qt_binding.QtCore import QThread
00034 
00035 
00036 class WorkerThread(QThread):
00037 
00038     """Convenience wrapper around QThread allowing to easily run code in a separate thread,
00039     get notified upon completion and kill the thread synchronously."""
00040 
00041     def __init__(self, run_callback, finished_callback=None):
00042         super(WorkerThread, self).__init__()
00043         self.run = run_callback
00044         self._finished_callback = finished_callback
00045 
00046     def start(self):
00047         # reconnect finished signal
00048         self.finished.connect(self._finished_handler)
00049         super(WorkerThread, self).start()
00050 
00051     def _finished_handler(self):
00052         # disconnect finished signal to avoid being called twice
00053         self.finished.disconnect(self._finished_handler)
00054         if self._finished_callback is not None:
00055             self._finished_callback()
00056 
00057     def kill(self):
00058         if self.isRunning():
00059             # clean up
00060             self.finished.disconnect(self._finished_handler)
00061             self.terminate()
00062             self.wait()


qt_gui_py_common
Author(s): Dorian Scholz
autogenerated on Mon Oct 6 2014 03:57:55