-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathThreadSafeFramesQueue_8hpp_source.html
87 lines (85 loc) · 16.7 KB
/
ThreadSafeFramesQueue_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>kNOw SIGN: src/ThreadSafeFramesQueue.hpp 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>
<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">kNOw SIGN
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ThreadSafeFramesQueue.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="ThreadSafeFramesQueue_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <limits></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <queue></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <opencv2/core/utility.hpp></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="classThreadSafeFramesQueue.html">ThreadSafeFramesQueue</a> : <span class="keyword">public</span> std::queue<T> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a14f494304f2bbe93c13188637396a7c7"> 29</a></span>  <a class="code" href="classThreadSafeFramesQueue.html#a14f494304f2bbe93c13188637396a7c7">ThreadSafeFramesQueue</a>()</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  : <a class="code" href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426">maxDepth</a>(5) {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.reset();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.start();</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#ae69b2911621b5a2a128ba8ce65447007"> 38</a></span>  <span class="keyword">explicit</span> <a class="code" href="classThreadSafeFramesQueue.html#ae69b2911621b5a2a128ba8ce65447007">ThreadSafeFramesQueue</a>(<span class="keywordtype">size_t</span> <span class="keyword">const</span>& _maxDepth)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  : <a class="code" href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426">maxDepth</a>(_maxDepth) {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.reset();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.start();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a404c19a906a6b25ed81f0427de8f833d"> 47</a></span>  <span class="keywordtype">void</span> <a class="code" href="classThreadSafeFramesQueue.html#a404c19a906a6b25ed81f0427de8f833d">Push</a>(<span class="keyword">const</span> T& entry) noexcept {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::lock_guard<std::mutex> lock(<a class="code" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">mtx</a>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">while</span> (this->size() >= <a class="code" href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426">maxDepth</a>) {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  T elem;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static_cast<</span><span class="keywordtype">void</span><span class="keyword">></span>(<a class="code" href="classThreadSafeFramesQueue.html#a5448db3937c27e5e58c175f38d26e2b2">Pop</a>(elem));</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  this->push(entry);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a5448db3937c27e5e58c175f38d26e2b2"> 60</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classThreadSafeFramesQueue.html#a5448db3937c27e5e58c175f38d26e2b2">Pop</a>(T& out) noexcept {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::lock_guard<std::mutex> lock(<a class="code" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">mtx</a>);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (this->empty()) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  out = this->front();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  this->pop();</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.stop();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.start();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a2c501970ecd6cbc0ae03360f99767261"> 81</a></span>  <span class="keywordtype">double</span> <a class="code" href="classThreadSafeFramesQueue.html#a2c501970ecd6cbc0ae03360f99767261">GetFPS</a>() noexcept {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::lock_guard<std::mutex> lock(<a class="code" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">mtx</a>);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>.getFPS();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#abc56deb11c5d03e412e501608759a653"> 89</a></span>  <span class="keywordtype">void</span> <a class="code" href="classThreadSafeFramesQueue.html#abc56deb11c5d03e412e501608759a653">Clear</a>() noexcept {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::lock_guard<std::mutex> lock(<a class="code" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">mtx</a>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">while</span> (!this->empty()) {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  this->pop();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e"> 97</a></span>  cv::TickMeter <a class="code" href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">tm</a>; </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b"> 98</a></span>  std::mutex <a class="code" href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">mtx</a>; </div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426"> 99</a></span>  <span class="keywordtype">size_t</span> <span class="keyword">const</span> <a class="code" href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426">maxDepth</a>; </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div><div class="ttc" id="classThreadSafeFramesQueue_html_a7116c72e26796d2318a6f721a5056426"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a7116c72e26796d2318a6f721a5056426">ThreadSafeFramesQueue::maxDepth</a></div><div class="ttdeci">size_t const maxDepth</div><div class="ttdoc">mutex for safe read/write access of/to queue internals </div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:99</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_ae69b2911621b5a2a128ba8ce65447007"><div class="ttname"><a href="classThreadSafeFramesQueue.html#ae69b2911621b5a2a128ba8ce65447007">ThreadSafeFramesQueue::ThreadSafeFramesQueue</a></div><div class="ttdeci">ThreadSafeFramesQueue(size_t const &_maxDepth)</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:38</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_a30d05116f273b4e24bb87eaf3c69292b"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a30d05116f273b4e24bb87eaf3c69292b">ThreadSafeFramesQueue::mtx</a></div><div class="ttdeci">std::mutex mtx</div><div class="ttdoc">OpenCV timer class. </div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:98</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_ac456c38421b1546dc83ad67a11fd017e"><div class="ttname"><a href="classThreadSafeFramesQueue.html#ac456c38421b1546dc83ad67a11fd017e">ThreadSafeFramesQueue::tm</a></div><div class="ttdeci">cv::TickMeter tm</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:97</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html"><div class="ttname"><a href="classThreadSafeFramesQueue.html">ThreadSafeFramesQueue</a></div><div class="ttdoc">thread-safe queue (FIFO) implementation (with timer) </div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:24</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_a2c501970ecd6cbc0ae03360f99767261"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a2c501970ecd6cbc0ae03360f99767261">ThreadSafeFramesQueue::GetFPS</a></div><div class="ttdeci">double GetFPS() noexcept</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:81</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_abc56deb11c5d03e412e501608759a653"><div class="ttname"><a href="classThreadSafeFramesQueue.html#abc56deb11c5d03e412e501608759a653">ThreadSafeFramesQueue::Clear</a></div><div class="ttdeci">void Clear() noexcept</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:89</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_a14f494304f2bbe93c13188637396a7c7"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a14f494304f2bbe93c13188637396a7c7">ThreadSafeFramesQueue::ThreadSafeFramesQueue</a></div><div class="ttdeci">ThreadSafeFramesQueue()</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:29</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_a404c19a906a6b25ed81f0427de8f833d"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a404c19a906a6b25ed81f0427de8f833d">ThreadSafeFramesQueue::Push</a></div><div class="ttdeci">void Push(const T &entry) noexcept</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:47</div></div>
<div class="ttc" id="classThreadSafeFramesQueue_html_a5448db3937c27e5e58c175f38d26e2b2"><div class="ttname"><a href="classThreadSafeFramesQueue.html#a5448db3937c27e5e58c175f38d26e2b2">ThreadSafeFramesQueue::Pop</a></div><div class="ttdeci">bool Pop(T &out) noexcept</div><div class="ttdef"><b>Definition:</b> ThreadSafeFramesQueue.hpp:60</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>