<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>FGx: src/utilities/workThread.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FGx
 <span id="projectnumber">1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7b5d38f1875f1b693f62ca6a108a1129.html">utilities</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">workThread.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* ==================================================</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Threading project</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Created: Geoff R. McLane - Aug 2011</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> License: GPL2 (or later)</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> copied to FGx project</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> ================================================== */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/* ********************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * workThread.cpp[.h]</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Created by Geoff R. Mclane, Paris</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * (c) Aug 2011 GPL2 (or later)</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Create a simple 'worker' thread, using QThread</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Instantiation: Either through declaration</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * workThread thread, or allocated</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * workThread * worker = new workThread, and remember</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * to do 'delete worker' at end of the application.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * API: Call job_number = worker->work( function ), with the function</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * to be run. Function must be void foo() type.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * 2011-08-29: Or the function can be void foo(void *) type</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * This can be called multiple times, and the 'jobs' will be stacked,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * and processed one after the other.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SIGNAL: workThread emits a work_done(int,int) when completed, passing the</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * job number, and ms of running, so use</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * connect(worker, SIGNAL(work_done(int,int)),</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * this, SLOT(done_it(int,int)));</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * to connect this to a SLOT job_done(int job_number, int ms)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> *</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Presently, if processing a LONG job at application exit, the full exit of</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * the application will only happen when the job is done.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * A future enhancement would be to provide a 'cancel' mechanism, to enable</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * killing the thread even if 'working'...</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> ** "AS IS" WITH NO EXPRESS OR IMPLIED WARRANTIES OF ANY TYPE.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> ******************************************************** */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef WORKTHREAD_H</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define WORKTHREAD_H</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/* =======================================================</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> HISTORY: Growing upwards</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> 2011/12/14 - In qt_osm_map project, remove macro - always use (void *), and</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> removed 'WorkType' enum. change to int, defined by user.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> Add loginfo(QString), for easy change of outLog(msg)</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> 2011/08/31 - Add passing of a void * to the function, under macro ADD_VOID_PTR</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> 2011/08/24 - First implementation in qt_test_gui/src/workThread.cpp</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> ======================================================= */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#include <QThread></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include <QMutex></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#include <QWaitCondition></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#include <QTime></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#include <QList></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#include "utilities.h"</span> <span class="comment">// for outLog(msg) and getElapTimeStg(ms)</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">typedef</span> void (*ACTION)(<span class="keywordtype">void</span> *);</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structtagWORKITEM.html"> 58</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structtagWORKITEM.html">tagWORKITEM</a> {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  ACTION act;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> * vp;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> user_type; <span class="comment">// defined by user</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">bool</span> abort;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> }<a class="code" href="structtagWORKITEM.html">WORKITEM</a>, * <a class="code" href="structtagWORKITEM.html">PWORKITEM</a>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">typedef</span> QList<WORKITEM> THREAD_LIST;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classworkThread.html"> 66</a></span> <span class="keyword">class </span><a class="code" href="classworkThread.html">workThread</a> : <span class="keyword">public</span> QThread</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  Q_OBJECT</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classworkThread.html">workThread</a>(QObject *parent = 0);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ~<a class="code" href="classworkThread.html">workThread</a>();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> in_function;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">bool</span> was_terminated;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">int</span> work(ACTION func, <span class="keywordtype">void</span> *vp);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> loginfo(QString msg) {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#ifdef GEN_UTILITIES_H</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  outLog(msg);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  Q_UNUSED(msg);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif // #ifdef GEN_UTILITIES_H</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> signals:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> work_done(<span class="keywordtype">int</span> jn, <span class="keywordtype">int</span> ms);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> run();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  QMutex mutex;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  QWaitCondition condition;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">int</span> restart;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">bool</span> abort;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  THREAD_LIST jobs;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">int</span> jobs_in;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">int</span> jobs_out;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">int</span> cyc_count;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">int</span> cum_running;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  QTime wt;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> };</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// a convenient SLEEP (ms) function</span></div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classSleeperThread.html"> 104</a></span> <span class="keyword">class </span><a class="code" href="classSleeperThread.html">SleeperThread</a> : <span class="keyword">public</span> QThread</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> msleep(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> msecs)</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  QThread::msleep(msecs);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// structure for the application</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// to keep track of 'work' passed to thread</span></div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="structtagWORK.html"> 115</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structtagWORK.html">tagWORK</a> {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> work_type; <span class="comment">// will determine actions when DONE</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">int</span> work_num;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  QTime work_tt;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  QString work_desc;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">bool</span> work_done;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">bool</span> abort_work;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> }<a class="code" href="structtagWORK.html">WORK</a>, *<a class="code" href="structtagWORK.html">PWORK</a>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">typedef</span> QList<PWORK> WORK_LIST;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif // WORKTHREAD_H</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// eof - workthread.h</span></div><div class="ttc" id="structtagWORK_html"><div class="ttname"><a href="structtagWORK.html">tagWORK</a></div><div class="ttdef"><b>Definition:</b> workThread.h:115</div></div>
<div class="ttc" id="classworkThread_html"><div class="ttname"><a href="classworkThread.html">workThread</a></div><div class="ttdef"><b>Definition:</b> workThread.h:66</div></div>
<div class="ttc" id="classSleeperThread_html"><div class="ttname"><a href="classSleeperThread.html">SleeperThread</a></div><div class="ttdef"><b>Definition:</b> workThread.h:104</div></div>
<div class="ttc" id="structtagWORKITEM_html"><div class="ttname"><a href="structtagWORKITEM.html">tagWORKITEM</a></div><div class="ttdef"><b>Definition:</b> workThread.h:58</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 4 2016 13:59:22 for FGx by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
004fd8e0018ea6f0df74e9703299ee08
>
files
>
584
