-
Notifications
You must be signed in to change notification settings - Fork 0
/
classapf_1_1CommandQueue_1_1WaitCommand.html
180 lines (171 loc) · 14.5 KB
/
classapf_1_1CommandQueue_1_1WaitCommand.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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audio Processing Framework (APF): apf::CommandQueue::WaitCommand Class Reference</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 id="projectrow">
<td id="projectalign">
<div id="projectname">Audio Processing Framework (APF)<span id="projectnumber"> version 0.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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="namespaceapf.html">apf</a></li><li class="navelem"><a class="el" href="classapf_1_1CommandQueue.html">CommandQueue</a></li><li class="navelem"><a class="el" href="classapf_1_1CommandQueue_1_1WaitCommand.html">WaitCommand</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classapf_1_1CommandQueue_1_1WaitCommand-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">apf::CommandQueue::WaitCommand Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Dummy command to synchronize with non-realtime thread.
<a href="classapf_1_1CommandQueue_1_1WaitCommand.html#details">More...</a></p>
<p><code>#include <<a class="el" href="commandqueue_8h_source.html">apf/commandqueue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for apf::CommandQueue::WaitCommand:</div>
<div class="dyncontent">
<div class="center"><img src="classapf_1_1CommandQueue_1_1WaitCommand__inherit__graph.png" border="0" usemap="#aapf_1_1CommandQueue_1_1WaitCommand_inherit__map" alt="Inheritance graph"/></div>
<map name="aapf_1_1CommandQueue_1_1WaitCommand_inherit__map" id="aapf_1_1CommandQueue_1_1WaitCommand_inherit__map">
<area shape="rect" title="Dummy command to synchronize with non-realtime thread." alt="" coords="5,169,172,211"/>
<area shape="rect" href="structapf_1_1CommandQueue_1_1Command.html" title="Abstract base class for realtime commands." alt="" coords="5,80,172,121"/>
<area shape="rect" href="classapf_1_1NonCopyable.html" title="Classes derived from this class cannot be copied (but still moved)." alt="" coords="20,5,157,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bcb3eda782f7e1125efcfb071a51eba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1CommandQueue_1_1WaitCommand.html#a2bcb3eda782f7e1125efcfb071a51eba">WaitCommand</a> (bool &done)</td></tr>
<tr class="memdesc:a2bcb3eda782f7e1125efcfb071a51eba"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classapf_1_1CommandQueue_1_1WaitCommand.html#a2bcb3eda782f7e1125efcfb071a51eba">More...</a><br /></td></tr>
<tr class="separator:a2bcb3eda782f7e1125efcfb071a51eba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structapf_1_1CommandQueue_1_1Command"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structapf_1_1CommandQueue_1_1Command')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structapf_1_1CommandQueue_1_1Command.html">apf::CommandQueue::Command</a></td></tr>
<tr class="memitem:a69afcf55dacc2ae3106a4b892a550249 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="structapf_1_1CommandQueue_1_1Command.html#a69afcf55dacc2ae3106a4b892a550249">~Command</a> ()</td></tr>
<tr class="memdesc:a69afcf55dacc2ae3106a4b892a550249 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="mdescLeft"> </td><td class="mdescRight">Empty virtual destructor. <a href="structapf_1_1CommandQueue_1_1Command.html#a69afcf55dacc2ae3106a4b892a550249">More...</a><br /></td></tr>
<tr class="separator:a69afcf55dacc2ae3106a4b892a550249 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49a784a8d8d88103d66e4bfe0df02202 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structapf_1_1CommandQueue_1_1Command.html#a49a784a8d8d88103d66e4bfe0df02202">execute</a> ()=0</td></tr>
<tr class="memdesc:a49a784a8d8d88103d66e4bfe0df02202 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="mdescLeft"> </td><td class="mdescRight">The actual implementation of the command. <a href="structapf_1_1CommandQueue_1_1Command.html#a49a784a8d8d88103d66e4bfe0df02202">More...</a><br /></td></tr>
<tr class="separator:a49a784a8d8d88103d66e4bfe0df02202 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ee49326e9dc188adc84688203c42954 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structapf_1_1CommandQueue_1_1Command.html#a1ee49326e9dc188adc84688203c42954">cleanup</a> ()=0</td></tr>
<tr class="memdesc:a1ee49326e9dc188adc84688203c42954 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="mdescLeft"> </td><td class="mdescRight">Cleanup of resources. <a href="structapf_1_1CommandQueue_1_1Command.html#a1ee49326e9dc188adc84688203c42954">More...</a><br /></td></tr>
<tr class="separator:a1ee49326e9dc188adc84688203c42954 inherit pub_methods_structapf_1_1CommandQueue_1_1Command"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classapf_1_1NonCopyable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classapf_1_1NonCopyable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classapf_1_1NonCopyable.html">apf::NonCopyable</a></td></tr>
<tr class="memitem:a2cb9777c7e6fd742f3b8da35c17f4bdf inherit pub_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"><a id="a2cb9777c7e6fd742f3b8da35c17f4bdf" name="a2cb9777c7e6fd742f3b8da35c17f4bdf"></a>
 </td><td class="memItemRight" valign="bottom"><b>NonCopyable</b> (const <a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> &)=delete</td></tr>
<tr class="separator:a2cb9777c7e6fd742f3b8da35c17f4bdf inherit pub_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abea4e89f98d1214da0765c2b9d3130d8 inherit pub_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"><a id="abea4e89f98d1214da0765c2b9d3130d8" name="abea4e89f98d1214da0765c2b9d3130d8"></a>
<a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> &)=delete</td></tr>
<tr class="separator:abea4e89f98d1214da0765c2b9d3130d8 inherit pub_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae18570048a9a874dd092066d89f5819f inherit pub_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"><a id="ae18570048a9a874dd092066d89f5819f" name="ae18570048a9a874dd092066d89f5819f"></a>
 </td><td class="memItemRight" valign="bottom"><b>NonCopyable</b> (<a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> &&)=default</td></tr>
<tr class="separator:ae18570048a9a874dd092066d89f5819f inherit pub_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e31c60377328c8cfbee60da6a58205f inherit pub_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"><a id="a9e31c60377328c8cfbee60da6a58205f" name="a9e31c60377328c8cfbee60da6a58205f"></a>
<a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classapf_1_1NonCopyable.html">NonCopyable</a> &&)=default</td></tr>
<tr class="separator:a9e31c60377328c8cfbee60da6a58205f inherit pub_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classapf_1_1NonCopyable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classapf_1_1NonCopyable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classapf_1_1NonCopyable.html">apf::NonCopyable</a></td></tr>
<tr class="memitem:af426fbece9a4254b89df1abb8742dfde inherit pro_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1NonCopyable.html#af426fbece9a4254b89df1abb8742dfde">NonCopyable</a> ()=default</td></tr>
<tr class="memdesc:af426fbece9a4254b89df1abb8742dfde inherit pro_methods_classapf_1_1NonCopyable"><td class="mdescLeft"> </td><td class="mdescRight">Protected default constructor. <a href="classapf_1_1NonCopyable.html#af426fbece9a4254b89df1abb8742dfde">More...</a><br /></td></tr>
<tr class="separator:af426fbece9a4254b89df1abb8742dfde inherit pro_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87183bd8ef0142555dd0796d5a4603f3 inherit pro_methods_classapf_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classapf_1_1NonCopyable.html#a87183bd8ef0142555dd0796d5a4603f3">~NonCopyable</a> ()=default</td></tr>
<tr class="memdesc:a87183bd8ef0142555dd0796d5a4603f3 inherit pro_methods_classapf_1_1NonCopyable"><td class="mdescLeft"> </td><td class="mdescRight">Protected non-virtual destructor. <a href="classapf_1_1NonCopyable.html#a87183bd8ef0142555dd0796d5a4603f3">More...</a><br /></td></tr>
<tr class="separator:a87183bd8ef0142555dd0796d5a4603f3 inherit pro_methods_classapf_1_1NonCopyable"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Dummy command to synchronize with non-realtime thread. </p>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00069">69</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a2bcb3eda782f7e1125efcfb071a51eba" name="a2bcb3eda782f7e1125efcfb071a51eba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bcb3eda782f7e1125efcfb071a51eba">◆ </a></span>WaitCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">apf::CommandQueue::WaitCommand::WaitCommand </td>
<td>(</td>
<td class="paramtype">bool & </td>
<td class="paramname"><em>done</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">done</td><td>is set to <b>true</b> when cleanup() is called. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="commandqueue_8h_source.html#l00073">73</a> of file <a class="el" href="commandqueue_8h_source.html">commandqueue.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>apf/<a class="el" href="commandqueue_8h_source.html">commandqueue.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>