forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1ExecutorObserver.html
More file actions
260 lines (247 loc) · 14.6 KB
/
classtf_1_1ExecutorObserver.html
File metadata and controls
260 lines (247 loc) · 14.6 KB
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!-- HTML header for doxygen 1.8.13-->
<!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>Cpp-Taskflow</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>
 <span id="projectnumber">2.2.0</span>
</div>
</td>
<td> <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>
</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classtf_1_1ExecutorObserver.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classtf_1_1ExecutorObserver-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::ExecutorObserver Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Default executor observer to dump the execution timelines.
<a href="classtf_1_1ExecutorObserver.html#details">More...</a></p>
<p><code>#include <<a class="el" href="observer_8hpp_source.html">observer.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for tf::ExecutorObserver:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1ExecutorObserver__inherit__graph.png" border="0" usemap="#tf_1_1ExecutorObserver_inherit__map" alt="Inheritance graph"/></div>
<map name="tf_1_1ExecutorObserver_inherit__map" id="tf_1_1ExecutorObserver_inherit__map">
<area shape="rect" id="node2" href="classtf_1_1ExecutorObserverInterface.html" title="The interface class for creating an executor observer. " alt="" coords="5,5,200,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for tf::ExecutorObserver:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1ExecutorObserver__coll__graph.png" border="0" usemap="#tf_1_1ExecutorObserver_coll__map" alt="Collaboration graph"/></div>
<map name="tf_1_1ExecutorObserver_coll__map" id="tf_1_1ExecutorObserver_coll__map">
<area shape="rect" id="node2" href="classtf_1_1ExecutorObserverInterface.html" title="The interface class for creating an executor observer. " alt="" coords="5,5,200,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a20f77a06e0f10dc67f7a5742add5b00a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ExecutorObserver.html#a20f77a06e0f10dc67f7a5742add5b00a">dump</a> (<a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &ostream) const</td></tr>
<tr class="memdesc:a20f77a06e0f10dc67f7a5742add5b00a"><td class="mdescLeft"> </td><td class="mdescRight">dump the timelines in JSON format to an ostream <a href="#a20f77a06e0f10dc67f7a5742add5b00a">More...</a><br /></td></tr>
<tr class="separator:a20f77a06e0f10dc67f7a5742add5b00a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1207fd394fa292f657a8ed4f0891858"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ExecutorObserver.html#af1207fd394fa292f657a8ed4f0891858">dump</a> () const</td></tr>
<tr class="memdesc:af1207fd394fa292f657a8ed4f0891858"><td class="mdescLeft"> </td><td class="mdescRight">dump the timelines in JSON to a <a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a href="#af1207fd394fa292f657a8ed4f0891858">More...</a><br /></td></tr>
<tr class="separator:af1207fd394fa292f657a8ed4f0891858"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc78a004eaa25022a20fd16a35f607ce"><td class="memItemLeft" align="right" valign="top"><a id="adc78a004eaa25022a20fd16a35f607ce"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ExecutorObserver.html#adc78a004eaa25022a20fd16a35f607ce">clear</a> ()</td></tr>
<tr class="memdesc:adc78a004eaa25022a20fd16a35f607ce"><td class="mdescLeft"> </td><td class="mdescRight">clear the timeline data <br /></td></tr>
<tr class="separator:adc78a004eaa25022a20fd16a35f607ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93d51307198abb9a1fc00a14904c3dd0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ExecutorObserver.html#a93d51307198abb9a1fc00a14904c3dd0">num_tasks</a> () const</td></tr>
<tr class="memdesc:a93d51307198abb9a1fc00a14904c3dd0"><td class="mdescLeft"> </td><td class="mdescRight">get the number of total tasks in the observer <a href="#a93d51307198abb9a1fc00a14904c3dd0">More...</a><br /></td></tr>
<tr class="separator:a93d51307198abb9a1fc00a14904c3dd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classtf_1_1ExecutorObserverInterface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtf_1_1ExecutorObserverInterface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtf_1_1ExecutorObserverInterface.html">tf::ExecutorObserverInterface</a></td></tr>
<tr class="memitem:a239e48ee46d73bcd5a3f28b3e1b8fe50 inherit pub_methods_classtf_1_1ExecutorObserverInterface"><td class="memItemLeft" align="right" valign="top"><a id="a239e48ee46d73bcd5a3f28b3e1b8fe50"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1ExecutorObserverInterface.html#a239e48ee46d73bcd5a3f28b3e1b8fe50">~ExecutorObserverInterface</a> ()=default</td></tr>
<tr class="memdesc:a239e48ee46d73bcd5a3f28b3e1b8fe50 inherit pub_methods_classtf_1_1ExecutorObserverInterface"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br /></td></tr>
<tr class="separator:a239e48ee46d73bcd5a3f28b3e1b8fe50 inherit pub_methods_classtf_1_1ExecutorObserverInterface"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a763b2f90bc53f92d680a635fe28e858e"><td class="memItemLeft" align="right" valign="top"><a id="a763b2f90bc53f92d680a635fe28e858e"></a>
class </td><td class="memItemRight" valign="bottom"><b>Executor</b></td></tr>
<tr class="separator:a763b2f90bc53f92d680a635fe28e858e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Default executor observer to dump the execution timelines. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a20f77a06e0f10dc67f7a5742add5b00a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f77a06e0f10dc67f7a5742add5b00a">◆ </a></span>dump() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void tf::ExecutorObserver::dump </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td>
<td class="paramname"><em>ostream</em></td><td>)</td>
<td> const</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>dump the timelines in JSON format to an ostream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ostream</td><td>the target <a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> to dump </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af1207fd394fa292f657a8ed4f0891858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1207fd394fa292f657a8ed4f0891858">◆ </a></span>dump() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> tf::ExecutorObserver::dump </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>dump the timelines in JSON to a <a class="elRef" doxygen="/home/tsung-wei/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </p>
<dl class="section return"><dt>Returns</dt><dd>a JSON string </dd></dl>
</div>
</div>
<a id="a93d51307198abb9a1fc00a14904c3dd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93d51307198abb9a1fc00a14904c3dd0">◆ </a></span>num_tasks()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t tf::ExecutorObserver::num_tasks </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>get the number of total tasks in the observer </p>
<dl class="section return"><dt>Returns</dt><dd>number of total tasks </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="observer_8hpp_source.html">observer.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>tf</b></li><li class="navelem"><a class="el" href="classtf_1_1ExecutorObserver.html">ExecutorObserver</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>