blob: bf2d9f05e57f139dab5ad735bd7774f3666563dd [file] [log] [blame]
<!-- Copyright (c) 2020 ARM Limited. -->
<!-- -->
<!-- SPDX-License-Identifier: MIT -->
<!-- -->
<!-- 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="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: ISendCounterPacket 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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;">
<img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02</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_send_counter_packet.xhtml','');});
</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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classarmnn_1_1profiling_1_1_i_send_counter_packet-members.xhtml">List of all members</a> </div>
<div class="headertitle">
<div class="title">ISendCounterPacket 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_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ISendCounterPacket:</div>
<div class="dyncontent">
<div class="center">
<img src="classarmnn_1_1profiling_1_1_i_send_counter_packet.png" usemap="#ISendCounterPacket_map" alt=""/>
<map id="ISendCounterPacket_map" name="ISendCounterPacket_map">
<area href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml" alt="MockSendCounterPacket" shape="rect" coords="0,56,155,80"/>
<area href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml" alt="SendCounterPacket" shape="rect" coords="165,56,320,80"/>
<area href="classarmnn_1_1profiling_1_1_send_counter_packet_test.xhtml" alt="SendCounterPacketTest" shape="rect" coords="165,112,320,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a80cb41c63cb6d3a19870b3a0a8f21ba7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> = std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_counter_value.xhtml">CounterValue</a> &gt;</td></tr>
<tr class="separator:a80cb41c63cb6d3a19870b3a0a8f21ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a583357d6511e6cb6084829e4f7cd1315"><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_send_counter_packet.xhtml#a583357d6511e6cb6084829e4f7cd1315">~ISendCounterPacket</a> ()</td></tr>
<tr class="separator:a583357d6511e6cb6084829e4f7cd1315"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14e9efe48e3d4ed05396f8a856bfaeea"><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_send_counter_packet.xhtml#a14e9efe48e3d4ed05396f8a856bfaeea">SendStreamMetaDataPacket</a> ()=0</td></tr>
<tr class="memdesc:a14e9efe48e3d4ed05396f8a856bfaeea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a StreamMetaDataPacket in the buffer. <a href="#a14e9efe48e3d4ed05396f8a856bfaeea">More...</a><br /></td></tr>
<tr class="separator:a14e9efe48e3d4ed05396f8a856bfaeea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3331355e62b6008340c27e82be9a851"><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_send_counter_packet.xhtml#ae3331355e62b6008340c27e82be9a851">SendCounterDirectoryPacket</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> &amp;counterDirectory)=0</td></tr>
<tr class="memdesc:ae3331355e62b6008340c27e82be9a851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a CounterDirectoryPacket from the parameters to the buffer. <a href="#ae3331355e62b6008340c27e82be9a851">More...</a><br /></td></tr>
<tr class="separator:ae3331355e62b6008340c27e82be9a851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeacf0722dbf513d511b46a9bf43bfa4a"><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_send_counter_packet.xhtml#aeacf0722dbf513d511b46a9bf43bfa4a">SendPeriodicCounterCapturePacket</a> (uint64_t timestamp, const <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> &amp;values)=0</td></tr>
<tr class="memdesc:aeacf0722dbf513d511b46a9bf43bfa4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a PeriodicCounterCapturePacket from the parameters to the buffer. <a href="#aeacf0722dbf513d511b46a9bf43bfa4a">More...</a><br /></td></tr>
<tr class="separator:aeacf0722dbf513d511b46a9bf43bfa4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6435f063192414c6dc68ef2f31628a5c"><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_send_counter_packet.xhtml#a6435f063192414c6dc68ef2f31628a5c">SendPeriodicCounterSelectionPacket</a> (uint32_t capturePeriod, const std::vector&lt; uint16_t &gt; &amp;selectedCounterIds)=0</td></tr>
<tr class="memdesc:a6435f063192414c6dc68ef2f31628a5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write a PeriodicCounterSelectionPacket from the parameters to the buffer. <a href="#a6435f063192414c6dc68ef2f31628a5c">More...</a><br /></td></tr>
<tr class="separator:a6435f063192414c6dc68ef2f31628a5c"><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_send_counter_packet_8hpp_source.xhtml#l00017">17</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a80cb41c63cb6d3a19870b3a0a8f21ba7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80cb41c63cb6d3a19870b3a0a8f21ba7">&#9670;&nbsp;</a></span>IndexValuePairsVector</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> = std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_counter_value.xhtml">CounterValue</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00020">20</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a583357d6511e6cb6084829e4f7cd1315"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a583357d6511e6cb6084829e4f7cd1315">&#9670;&nbsp;</a></span>~ISendCounterPacket()</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_send_counter_packet.xhtml">ISendCounterPacket</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_send_counter_packet_8hpp_source.xhtml#l00022">22</a> of file <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.hpp</a>.</p>
<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#ae3331355e62b6008340c27e82be9a851">ISendCounterPacket::SendCounterDirectoryPacket()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#aeacf0722dbf513d511b46a9bf43bfa4a">ISendCounterPacket::SendPeriodicCounterCapturePacket()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a6435f063192414c6dc68ef2f31628a5c">ISendCounterPacket::SendPeriodicCounterSelectionPacket()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a14e9efe48e3d4ed05396f8a856bfaeea">ISendCounterPacket::SendStreamMetaDataPacket()</a>.</p>
<div class="fragment"><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae3331355e62b6008340c27e82be9a851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3331355e62b6008340c27e82be9a851">&#9670;&nbsp;</a></span>SendCounterDirectoryPacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SendCounterDirectoryPacket </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_directory.xhtml">ICounterDirectory</a> &amp;&#160;</td>
<td class="paramname"><em>counterDirectory</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>Create and write a CounterDirectoryPacket from the parameters to the buffer. </p>
<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a3b526a823530443efec886c4305e52de">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a3b526a823530443efec886c4305e52de">SendCounterPacket</a>.</p>
<p class="reference">Referenced by <a class="el" href="_connection_acknowledged_command_handler_8cpp_source.xhtml#l00018">ConnectionAcknowledgedCommandHandler::operator()()</a>, <a class="el" href="_request_counter_directory_command_handler_8cpp_source.xhtml#l00016">RequestCounterDirectoryCommandHandler::operator()()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
</div>
</div>
<a id="aeacf0722dbf513d511b46a9bf43bfa4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeacf0722dbf513d511b46a9bf43bfa4a">&#9670;&nbsp;</a></span>SendPeriodicCounterCapturePacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SendPeriodicCounterCapturePacket </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_send_counter_packet.xhtml#a80cb41c63cb6d3a19870b3a0a8f21ba7">IndexValuePairsVector</a> &amp;&#160;</td>
<td class="paramname"><em>values</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>Create and write a PeriodicCounterCapturePacket from the parameters to the buffer. </p>
<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#adae3557b7778010227466ce3eed0edb2">SendCounterPacket</a>.</p>
<p class="reference">Referenced by <a class="el" href="_backend_profiling_8cpp_source.xhtml#l00032">BackendProfiling::ReportCounters()</a>, <a class="el" href="_periodic_counter_capture_8cpp_source.xhtml#l00037">PeriodicCounterCapture::Stop()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
</div>
</div>
<a id="a6435f063192414c6dc68ef2f31628a5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6435f063192414c6dc68ef2f31628a5c">&#9670;&nbsp;</a></span>SendPeriodicCounterSelectionPacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SendPeriodicCounterSelectionPacket </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>selectedCounterIds</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>Create and write a PeriodicCounterSelectionPacket from the parameters to the buffer. </p>
<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a47406a4d108beb4f20031d370a155a9d">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a47406a4d108beb4f20031d370a155a9d">SendCounterPacket</a>.</p>
<p class="reference">Referenced by <a class="el" href="_periodic_counter_selection_command_handler_8cpp_source.xhtml#l00059">PeriodicCounterSelectionCommandHandler::operator()()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
</div>
</div>
<a id="a14e9efe48e3d4ed05396f8a856bfaeea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14e9efe48e3d4ed05396f8a856bfaeea">&#9670;&nbsp;</a></span>SendStreamMetaDataPacket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SendStreamMetaDataPacket </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>Create and write a StreamMetaDataPacket in the buffer. </p>
<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_mock_send_counter_packet.xhtml#a2a2e451c4e4963909b8a6dc7e7653cd1">MockSendCounterPacket</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_send_counter_packet.xhtml#a2a2e451c4e4963909b8a6dc7e7653cd1">SendCounterPacket</a>.</p>
<p class="reference">Referenced by <a class="el" href="_send_thread_8cpp_source.xhtml#l00081">SendThread::Stop()</a>, and <a class="el" href="_i_send_counter_packet_8hpp_source.xhtml#l00022">ISendCounterPacket::~ISendCounterPacket()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/profiling/<a class="el" href="_i_send_counter_packet_8hpp_source.xhtml">ISendCounterPacket.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.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_send_counter_packet.xhtml">ISendCounterPacket</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:09:21 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>