Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / e886b518909880b370fddf43ff39296252d03909 / . / Documentation / classarmnn_1_1profiling_1_1_i_consumer.html
blob: 85ae1e2f3988d530279ab5618e2751ea4a4ecc3a [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: IConsumer Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_consumer.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="classarmnn_1_1profiling_1_1_i_consumer-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">IConsumer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_i_consumer_8hpp_source.html">IConsumer.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for IConsumer:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="classarmnn_1_1profiling_1_1_i_consumer.png" usemap="#IConsumer_map" alt=""/>
97 <map id="IConsumer_map" name="IConsumer_map">
98<area href="classarmnn_1_1profiling_1_1_send_thread.html" alt="SendThread" shape="rect" coords="0,56,81,80"/>
99</map>
100 </div></div>
101<table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
103Public Member Functions</h2></td></tr>
104<tr class="memitem:a70e3766f4088883274c4daa1941f03b9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html#a70e3766f4088883274c4daa1941f03b9">~IConsumer</a> ()</td></tr>
105<tr class="separator:a70e3766f4088883274c4daa1941f03b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:a4b4fe1cfea0198d9defd88178f073365"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html#a4b4fe1cfea0198d9defd88178f073365">SetReadyToRead</a> ()=0</td></tr>
107<tr class="memdesc:a4b4fe1cfea0198d9defd88178f073365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a "ready to read" flag in the buffer to notify the reading thread to start reading it. <a href="#a4b4fe1cfea0198d9defd88178f073365">More...</a><br /></td></tr>
108<tr class="separator:a4b4fe1cfea0198d9defd88178f073365"><td class="memSeparator" colspan="2">&#160;</td></tr>
109</table>
110<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
111<div class="textblock">
112<p class="definition">Definition at line <a class="el" href="_i_consumer_8hpp_source.html#l00014">14</a> of file <a class="el" href="_i_consumer_8hpp_source.html">IConsumer.hpp</a>.</p>
113</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
114<a id="a70e3766f4088883274c4daa1941f03b9"></a>
115<h2 class="memtitle"><span class="permalink"><a href="#a70e3766f4088883274c4daa1941f03b9">&#9670;&nbsp;</a></span>~IConsumer()</h2>
116
117<div class="memitem">
118<div class="memproto">
119<table class="mlabels">
120 <tr>
121 <td class="mlabels-left">
122 <table class="memname">
123 <tr>
124 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a> </td>
125 <td>(</td>
126 <td class="paramname"></td><td>)</td>
127 <td></td>
128 </tr>
129 </table>
130 </td>
131 <td class="mlabels-right">
132<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
133 </tr>
134</table>
135</div><div class="memdoc">
136
137<p class="definition">Definition at line <a class="el" href="_i_consumer_8hpp_source.html#l00017">17</a> of file <a class="el" href="_i_consumer_8hpp_source.html">IConsumer.hpp</a>.</p>
138
139<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html#a4b4fe1cfea0198d9defd88178f073365">IConsumer::SetReadyToRead()</a>.</p>
140<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{}</div></div><!-- fragment -->
141</div>
142</div>
143<h2 class="groupheader">Member Function Documentation</h2>
144<a id="a4b4fe1cfea0198d9defd88178f073365"></a>
145<h2 class="memtitle"><span class="permalink"><a href="#a4b4fe1cfea0198d9defd88178f073365">&#9670;&nbsp;</a></span>SetReadyToRead()</h2>
146
147<div class="memitem">
148<div class="memproto">
149<table class="mlabels">
150 <tr>
151 <td class="mlabels-left">
152 <table class="memname">
153 <tr>
154 <td class="memname">virtual void SetReadyToRead </td>
155 <td>(</td>
156 <td class="paramname"></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160 </td>
161 <td class="mlabels-right">
162<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
163 </tr>
164</table>
165</div><div class="memdoc">
166
167<p>Set a "ready to read" flag in the buffer to notify the reading thread to start reading it. </p>
168
169<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_send_thread.html#ad2d0b47c9cfacb7abdb524878b07c9a7">SendThread</a>.</p>
170
171<p class="reference">Referenced by <a class="el" href="_buffer_manager_8cpp_source.html#l00116">BufferManager::FlushReadList()</a>, and <a class="el" href="_i_consumer_8hpp_source.html#l00017">IConsumer::~IConsumer()</a>.</p>
172
173</div>
174</div>
175<hr/>The documentation for this class was generated from the following file:<ul>
176<li>src/profiling/<a class="el" href="_i_consumer_8hpp_source.html">IConsumer.hpp</a></li>
177</ul>
178</div><!-- contents -->
179</div><!-- doc-content -->
180<!-- start footer part -->
181<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
182 <ul>
183 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.html">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a></li>
184 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
185 <a href="http://www.doxygen.org/index.html">
186 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
187 </ul>
188</div>
189</body>
190</html>