forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1TaskView.html
More file actions
201 lines (197 loc) · 17.1 KB
/
classtf_1_1TaskView.html
File metadata and controls
201 lines (197 loc) · 17.1 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
<!-- 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.14"/>
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>
 <span id="projectnumber">2.4-master-branch</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classtf_1_1TaskView.html','');});
/* @license-end */
</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="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classtf_1_1TaskView-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::TaskView Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>immutable accessor class to a task node used by <a class="el" href="classtf_1_1ExecutorObserver.html" title="Default executor observer to dump the execution timelines. ">tf::ExecutorObserver</a>
<a href="classtf_1_1TaskView.html#details">More...</a></p>
<p><code>#include <<a class="el" href="task_8hpp_source.html">task.hpp</a>></code></p>
<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:ada6755eb9db8badbf290eb25532a8d7f"><td class="memItemLeft" align="right" valign="top"><a id="ada6755eb9db8badbf290eb25532a8d7f"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#ada6755eb9db8badbf290eb25532a8d7f">TaskView</a> ()=default</td></tr>
<tr class="memdesc:ada6755eb9db8badbf290eb25532a8d7f"><td class="mdescLeft"> </td><td class="mdescRight">constructs an empty task view <br /></td></tr>
<tr class="separator:ada6755eb9db8badbf290eb25532a8d7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcc3095bec2afe51fffb0d2314c0e836"><td class="memItemLeft" align="right" valign="top"><a id="adcc3095bec2afe51fffb0d2314c0e836"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#adcc3095bec2afe51fffb0d2314c0e836">TaskView</a> (const <a class="el" href="classtf_1_1Task.html">Task</a> &task)</td></tr>
<tr class="memdesc:adcc3095bec2afe51fffb0d2314c0e836"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task view from a task <br /></td></tr>
<tr class="separator:adcc3095bec2afe51fffb0d2314c0e836"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c7b4378a67f39ee33724a4f96bc6abd"><td class="memItemLeft" align="right" valign="top"><a id="a7c7b4378a67f39ee33724a4f96bc6abd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a7c7b4378a67f39ee33724a4f96bc6abd">TaskView</a> (const <a class="el" href="classtf_1_1TaskView.html">TaskView</a> &other)</td></tr>
<tr class="memdesc:a7c7b4378a67f39ee33724a4f96bc6abd"><td class="mdescLeft"> </td><td class="mdescRight">constructs the task with the copy of the other task <br /></td></tr>
<tr class="separator:a7c7b4378a67f39ee33724a4f96bc6abd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6228f57867fcaeec9fd47e58be2773fd"><td class="memItemLeft" align="right" valign="top"><a id="a6228f57867fcaeec9fd47e58be2773fd"></a>
<a class="el" href="classtf_1_1TaskView.html">TaskView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a6228f57867fcaeec9fd47e58be2773fd">operator=</a> (const <a class="el" href="classtf_1_1TaskView.html">TaskView</a> &other)</td></tr>
<tr class="memdesc:a6228f57867fcaeec9fd47e58be2773fd"><td class="mdescLeft"> </td><td class="mdescRight">replaces the contents with a copy of the other task <br /></td></tr>
<tr class="separator:a6228f57867fcaeec9fd47e58be2773fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b8af1becc79b92d0f97b8397dc4c05b"><td class="memItemLeft" align="right" valign="top"><a id="a4b8af1becc79b92d0f97b8397dc4c05b"></a>
<a class="el" href="classtf_1_1TaskView.html">TaskView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a4b8af1becc79b92d0f97b8397dc4c05b">operator=</a> (const <a class="el" href="classtf_1_1Task.html">Task</a> &other)</td></tr>
<tr class="memdesc:a4b8af1becc79b92d0f97b8397dc4c05b"><td class="mdescLeft"> </td><td class="mdescRight">replaces the contents with another task <br /></td></tr>
<tr class="separator:a4b8af1becc79b92d0f97b8397dc4c05b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a148557f80bb73e600c00a4fde25ff5f7"><td class="memItemLeft" align="right" valign="top"><a id="a148557f80bb73e600c00a4fde25ff5f7"></a>
<a class="el" href="classtf_1_1TaskView.html">TaskView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a148557f80bb73e600c00a4fde25ff5f7">operator=</a> (<a class="elRef" doxygen="/Users/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/types/nullptr_t.html">std::nullptr_t</a>)</td></tr>
<tr class="memdesc:a148557f80bb73e600c00a4fde25ff5f7"><td class="mdescLeft"> </td><td class="mdescRight">replaces the contents with a null pointer <br /></td></tr>
<tr class="separator:a148557f80bb73e600c00a4fde25ff5f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac31f08774b5cb89bc56367739614abcd"><td class="memItemLeft" align="right" valign="top"><a id="ac31f08774b5cb89bc56367739614abcd"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#ac31f08774b5cb89bc56367739614abcd">operator==</a> (const <a class="el" href="classtf_1_1TaskView.html">TaskView</a> &) const</td></tr>
<tr class="memdesc:ac31f08774b5cb89bc56367739614abcd"><td class="mdescLeft"> </td><td class="mdescRight">compares if two taskviews are associated with the same task <br /></td></tr>
<tr class="separator:ac31f08774b5cb89bc56367739614abcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb557ad6ea636a2276022b04062e4725"><td class="memItemLeft" align="right" valign="top"><a id="adb557ad6ea636a2276022b04062e4725"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#adb557ad6ea636a2276022b04062e4725">operator!=</a> (const <a class="el" href="classtf_1_1TaskView.html">TaskView</a> &) const</td></tr>
<tr class="memdesc:adb557ad6ea636a2276022b04062e4725"><td class="mdescLeft"> </td><td class="mdescRight">compares if two taskviews are associated with different tasks <br /></td></tr>
<tr class="separator:adb557ad6ea636a2276022b04062e4725"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8cd58171de8ab4865e3c3f142db2db1"><td class="memItemLeft" align="right" valign="top"><a id="ac8cd58171de8ab4865e3c3f142db2db1"></a>
const <a class="elRef" doxygen="/Users/twhuang/PhD/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_1TaskView.html#ac8cd58171de8ab4865e3c3f142db2db1">name</a> () const</td></tr>
<tr class="memdesc:ac8cd58171de8ab4865e3c3f142db2db1"><td class="mdescLeft"> </td><td class="mdescRight">queries the name of the task <br /></td></tr>
<tr class="separator:ac8cd58171de8ab4865e3c3f142db2db1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff16d269ac75cffa55a312593f20d30d"><td class="memItemLeft" align="right" valign="top"><a id="aff16d269ac75cffa55a312593f20d30d"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#aff16d269ac75cffa55a312593f20d30d">num_successors</a> () const</td></tr>
<tr class="memdesc:aff16d269ac75cffa55a312593f20d30d"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of successors of the task <br /></td></tr>
<tr class="separator:aff16d269ac75cffa55a312593f20d30d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc4e2bef464e8fbb5706cefdf482a24f"><td class="memItemLeft" align="right" valign="top"><a id="acc4e2bef464e8fbb5706cefdf482a24f"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#acc4e2bef464e8fbb5706cefdf482a24f">num_dependents</a> () const</td></tr>
<tr class="memdesc:acc4e2bef464e8fbb5706cefdf482a24f"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of predecessors of the task <br /></td></tr>
<tr class="separator:acc4e2bef464e8fbb5706cefdf482a24f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7bcb9cb1ee8f020de56fdbf8e651388"><td class="memItemLeft" align="right" valign="top"><a id="ac7bcb9cb1ee8f020de56fdbf8e651388"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#ac7bcb9cb1ee8f020de56fdbf8e651388">num_strong_dependents</a> () const</td></tr>
<tr class="memdesc:ac7bcb9cb1ee8f020de56fdbf8e651388"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of strong dependents of the task <br /></td></tr>
<tr class="separator:ac7bcb9cb1ee8f020de56fdbf8e651388"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1ddd9a7e68a81feee1785ece99e58f5"><td class="memItemLeft" align="right" valign="top"><a id="ad1ddd9a7e68a81feee1785ece99e58f5"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#ad1ddd9a7e68a81feee1785ece99e58f5">num_weak_dependents</a> () const</td></tr>
<tr class="memdesc:ad1ddd9a7e68a81feee1785ece99e58f5"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of weak dependents of the task <br /></td></tr>
<tr class="separator:ad1ddd9a7e68a81feee1785ece99e58f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04c63b3e737474fb4157534d8a94eb64"><td class="memItemLeft" align="right" valign="top"><a id="a04c63b3e737474fb4157534d8a94eb64"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a04c63b3e737474fb4157534d8a94eb64">reset</a> ()</td></tr>
<tr class="memdesc:a04c63b3e737474fb4157534d8a94eb64"><td class="mdescLeft"> </td><td class="mdescRight">resets to an empty view <br /></td></tr>
<tr class="separator:a04c63b3e737474fb4157534d8a94eb64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29d974f0b79e5e8da9c935dfa28492d9"><td class="memItemLeft" align="right" valign="top"><a id="a29d974f0b79e5e8da9c935dfa28492d9"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a29d974f0b79e5e8da9c935dfa28492d9">empty</a> () const</td></tr>
<tr class="memdesc:a29d974f0b79e5e8da9c935dfa28492d9"><td class="mdescLeft"> </td><td class="mdescRight">queries if the task view is empty <br /></td></tr>
<tr class="separator:a29d974f0b79e5e8da9c935dfa28492d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cb647dc0064b5d11e0c87226c47f8f8"><td class="memTemplParams" colspan="2"><a id="a3cb647dc0064b5d11e0c87226c47f8f8"></a>
template<typename V > </td></tr>
<tr class="memitem:a3cb647dc0064b5d11e0c87226c47f8f8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a3cb647dc0064b5d11e0c87226c47f8f8">for_each_successor</a> (V &&visitor) const</td></tr>
<tr class="memdesc:a3cb647dc0064b5d11e0c87226c47f8f8"><td class="mdescLeft"> </td><td class="mdescRight">applies an visitor callable to each successor of the task <br /></td></tr>
<tr class="separator:a3cb647dc0064b5d11e0c87226c47f8f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55651e26436bfc2499cadaca4a24e48d"><td class="memTemplParams" colspan="2"><a id="a55651e26436bfc2499cadaca4a24e48d"></a>
template<typename V > </td></tr>
<tr class="memitem:a55651e26436bfc2499cadaca4a24e48d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskView.html#a55651e26436bfc2499cadaca4a24e48d">for_each_dependent</a> (V &&visitor) const</td></tr>
<tr class="memdesc:a55651e26436bfc2499cadaca4a24e48d"><td class="mdescLeft"> </td><td class="mdescRight">applies an visitor callable to each dependents of the task <br /></td></tr>
<tr class="separator:a55651e26436bfc2499cadaca4a24e48d"><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>immutable accessor class to a task node used by <a class="el" href="classtf_1_1ExecutorObserver.html" title="Default executor observer to dump the execution timelines. ">tf::ExecutorObserver</a> </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="task_8hpp_source.html">task.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_1TaskView.html">TaskView</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.14 </li>
</ul>
</div>
</body>
</html>