blob: 0f351d04ff2cc738f37b4c19383eedff07136289 [file] [log] [blame]
<!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>ArmNN: IBackendProfilingContext 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="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>
<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">ArmNN
&#160;<span id="projectnumber">NotReleased</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>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_backend_profiling_context.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="#pub-methods">Public Member Functions</a> &#124;
<a href="classarmnn_1_1profiling_1_1_i_backend_profiling_context-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IBackendProfilingContext Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IBackendProfilingContext:</div>
<div class="dyncontent">
<div class="center">
<img src="classarmnn_1_1profiling_1_1_i_backend_profiling_context.png" usemap="#IBackendProfilingContext_map" alt=""/>
<map id="IBackendProfilingContext_map" name="IBackendProfilingContext_map">
<area href="classarmnn_1_1_mock_backend_profiling_context.html" alt="MockBackendProfilingContext" shape="rect" coords="0,56,181,80"/>
</map>
</div></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:a9aeb82fc99434b8847b6274868cce79e"><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_backend_profiling_context.html#a9aeb82fc99434b8847b6274868cce79e">~IBackendProfilingContext</a> ()</td></tr>
<tr class="separator:a9aeb82fc99434b8847b6274868cce79e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7877cff32ce673cece82591034759a62"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a7877cff32ce673cece82591034759a62">RegisterCounters</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr>
<tr class="separator:a7877cff32ce673cece82591034759a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73cd771233a88545d3623f35c1fad4d4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a73cd771233a88545d3623f35c1fad4d4">ActivateCounters</a> (uint32_t capturePeriod, const std::vector&lt; uint16_t &gt; &amp;counterIds)=0</td></tr>
<tr class="separator:a73cd771233a88545d3623f35c1fad4d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a1d4c34ead611b06c3eae53f2ff47e8"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5a1d4c34ead611b06c3eae53f2ff47e8">ReportCounterValues</a> ()=0</td></tr>
<tr class="separator:a5a1d4c34ead611b06c3eae53f2ff47e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5589708f9f5ad739add36e631a3817b5"><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_backend_profiling_context.html#a5589708f9f5ad739add36e631a3817b5">EnableProfiling</a> (bool flag)=0</td></tr>
<tr class="separator:a5589708f9f5ad739add36e631a3817b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00016">16</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9aeb82fc99434b8847b6274868cce79e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9aeb82fc99434b8847b6274868cce79e">&#9670;&nbsp;</a></span>~IBackendProfilingContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html">IBackendProfilingContext</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">19</a> of file <a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.hpp</a>.</p>
<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a73cd771233a88545d3623f35c1fad4d4">IBackendProfilingContext::ActivateCounters()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5589708f9f5ad739add36e631a3817b5">IBackendProfilingContext::EnableProfiling()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a7877cff32ce673cece82591034759a62">IBackendProfilingContext::RegisterCounters()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling_context.html#a5a1d4c34ead611b06c3eae53f2ff47e8">IBackendProfilingContext::ReportCounterValues()</a>.</p>
<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; {}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a73cd771233a88545d3623f35c1fad4d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73cd771233a88545d3623f35c1fad4d4">&#9670;&nbsp;</a></span>ActivateCounters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt;std::string&gt; ActivateCounters </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>capturePeriod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; uint16_t &gt; &amp;&#160;</td>
<td class="paramname"><em>counterIds</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a85f69fcb2bf44c2689f5678a8261ba84">MockBackendProfilingContext</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
</div>
</div>
<a id="a5589708f9f5ad739add36e631a3817b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5589708f9f5ad739add36e631a3817b5">&#9670;&nbsp;</a></span>EnableProfiling()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void EnableProfiling </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>flag</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#adedefb2326efe87593f72e1bddc0ed1b">MockBackendProfilingContext</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
</div>
</div>
<a id="a7877cff32ce673cece82591034759a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7877cff32ce673cece82591034759a62">&#9670;&nbsp;</a></span>RegisterCounters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint16_t RegisterCounters </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>currentMaxGlobalCounterID</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a6f2834ca8b2c5f299a02b4a98c91b4d6">MockBackendProfilingContext</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
</div>
</div>
<a id="a5a1d4c34ead611b06c3eae53f2ff47e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a1d4c34ead611b06c3eae53f2ff47e8">&#9670;&nbsp;</a></span>ReportCounterValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a>&gt; ReportCounterValues </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend_profiling_context.html#a564b1c7251d4e994ff81994157ae6ffe">MockBackendProfilingContext</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_backend_profiling_context_8hpp_source.html#l00019">IBackendProfilingContext::~IBackendProfilingContext()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_context_8hpp_source.html">IBackendProfilingContext.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"><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_backend_profiling_context.html">IBackendProfilingContext</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN 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>