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